Edit on GitHub!

Pull requests

To add code to the different repositories the code is build in a feature branch and merged back to the develop or main branch. using a pull request. No direct committing is allowed to the branches develop and main.
When a release is created the branch develop is merged to the branch main using a pull request.
In some repositories the branch develop is skipped and not there. Feature branches are merged directly to the branch develop

Creating a pull request

When creating a pull request to merge a feature branch back we need to be aware that some information about the pull request is used to generate the release notes.

• Title: The title is added to the release notes, so give it a nice descriptive one.
• Labels: Use a label to add the pull request to correct section in the release notes.
  • enhancement: The pull request adds as a new feature.
  • bug: The pull request solves a bugfix.
  • tooling: Change or update to tooling used to build project.
• Linking issue: Link the correct issue using one of the keywords in the description, for example closes #1234. This only works when the PR is being merged to the default branch.

There is a special label dependencies used by dependabot for updating dependencies. These are grouped together in a separate section. If no label is added the pull request will be added to the section Other Changes at the bottom of the release notes.

The following labels cause the pull request to be ignored in the release notes:

• wontfix
• duplicate
• invalid

Remark: The label tooling is not a standard label, so that may need to be created by the first developer using it.

Code review

If you are a long time and trusted contributor, your can review your pull-requests with your collegues. Otherwise request the code owner of the repository to review your pull request. If you haven’t heard back in 3 days, report your pull request in the CoMPAS slack channel