Contributing

Contributor License Agreement

Atlassian requires contributors to sign a Contributor License Agreement, known as a CLA. This serves as a record stating that the contributor is entitled to contribute the code/documentation/translation to the project and is willing to have it used in distributions and derivative works (or is willing to transfer ownership).

Prior to accepting your contributions we ask that you please follow the appropriate link below to digitally sign the CLA. The Corporate CLA is for those who are contributing as a member of an organisation and the individual CLA is for those contributing as an individual.

Guidelines for pull requests

  • Write tests for any changes.
  • Follow existing code style and conventions.
  • Separate unrelated changes into multiple pull requests.
  • For bigger changes, make sure you start a discussion first by creating an issue and explaining the intended change.
  • Ensure the build is green before you open your PR. The Pipelines build won't run by default on a remote branch, so enable Pipelines.
  • Use conventional changelog standard in your commit messages.

Development dependencies

Setting up a development machine

To set up a virtual environment with all dependencies and run all tests:

make test

During development

To automatically execute tests after changes are detected in the project directory execute these commands in different terminals:

  • make watch
  • make watch-e2e

Documentation

Documentation is built using mkdocs. You can start an auto-refreshing document server with:

make docs-serve

Releasing a new version (for project administrators)

TBD