Reliable, automated end-to-end-testing that only depends on what is shown on your screen instead of the technology or platform you are running on

Humanizing UI Automation

Disclaimer

This repo is a monorepo consisting mainly of npm packages. We use workspaces to managing the different npm packages etc. This may change in the future as we plan to include also packages, libraries etc. written in other languages in this repo to make the power of askui available to non-typescript/-javascript developers as well.

Installation

Simply run an npm install inside the root directory.

$ npm install

Contributing

Branching

Your branch name should conform to the format <issue id>-<issue title lower-cased and kebab-cased>, e.g., let's say you have an issue named Hello World with id AS-101, the the branch name would be AS-101-hello-world. We use the issue id prefix to prepend a link to the issue to the commit message header. In some cases, when doing a quick fix of a typo etc. when there is no issue, feel free to just use a descriptive name of what you are doing, e.g., fix-typo-in-example-readme.

Commit Message Standard

Commit messages should conform to Conventional Commits Message Standard. Exceptions to this rule may be merge commits.

Adding Dependencies

The one version rule should be followed as much as possible. In practice, this mean checking if a dependency to be added is already used by another package or meant to be used by multiple packages. If not, install it inside the corresponding package's root directory, e.g., ./packages/askui-nodejs. If it is shared, install it in the project's root directory and make sure that you only need to depend on this single version in all packages.

Githooks

This monorepo uses githooks with husky to lint and test the code, to help you stick to the commit message standard by opening up a cli for constructing the commit message on each commit, prepending the commit message with the issue number or linting the commit message etc. In some cases, e.g., when using a Git client such as Git Tower or GitKraken, cherry-picking, rebasing or in a ci pipeline, you may want to disable githooks, especially the interactive cli.

For skipping the interactive cli when commiting, set the environment variable SKIP_CZ_CLI to true.

$ export SKIP_CZ_CLI=true

For skipping all githooks, set the environment variable HUSKY to 0.

$ export HUSKY=0

In a ci pipeline, the githooks are skipped by default.