Thanks for contributing to this repository!
This repository follows the following conventions:
To contribute a change:
- Create a fork of the existing repository
- On the project’s home page, in the top right, click Fork.
- Below Select a namespace to fork the project, identify the project you want to fork to, and click Select. Only namespaces you have Developer and higher permissions for are shown.
- GitHub creates your fork, and redirects you to the project page for your new fork. The permissions you have in the namespace are your permissions in the fork.
- Make the changes in code.
- Make commits using the Conventional Commits format. This helps with automation for changelog. Update
CHANGELOG.md
in the same commit using the Keep a Changelog. Depending on tooling maturity, this step may be automated. - Ensure all new commits from the
master
branch are rebased into your branch. - Open a merge request. If this merge request is solving a preexisting issue, add the issue reference into the description of the MR.
- Wait for a maintainer of the repository (see CODEOWNERS) to approve.
- If you have permissions to merge, you are responsible for merging. Otherwise, a CODEOWNER will merge the commit.