Skip to content

Pull Request Guidelines

Joakim Storløkken Melseth edited this page Dec 2, 2024 · 70 revisions

PR title

The title of the pull request needs to follow the commitlint pattern. You also need to add the Jira issue number [DHIS2-XXXXX]. An example of such a title would be

  • fix: [DHIS2-8519] field validation bug ….

By doing so we will have a clear history on the master branch.

Merge agreements

Developers review

You need at least one approval from the developers.

QA review

You need at least one approval from the QA. See more details on the Testing and QA workflow

Resolve conversation

The reviewer is in charge to click the "Resolve conversation" button once a solution was agreed upon and/or implemented.

CI Checks

The Cypress end-to-end tests run against a real backend instance. If the API has bugs then Cypress tests may fail.

All Cypress tests need to pass for the app to be published.

Dependabot PRs

Dependabot will automatically open pull requests to keep dependencies up-to-date. These PRs will have to be reviewed by developers.

The developers will have to determine, on a case-by-case basis, if running cypress tests against all backend versions is needed. Use label "e2e-tests" to run them or label "skip-e2e-tests" to skip.