diff --git a/DEVELOPERS.md b/DEVELOPERS.md new file mode 100644 index 00000000..8e9da9ce --- /dev/null +++ b/DEVELOPERS.md @@ -0,0 +1,190 @@ +# Developer Guide for contributing to MyParcel repositories + +This document is a guide for developers who want to contribute to MyParcel repositories. It contains information about the development process, how to create a pull request and how to write a good commit message. + +## Pull requests + +- A pull request should contain a single feature or bug fix. +- A pull request should be as small as possible. This makes it easier to review and merge. +- The title and description of the pull request must comply with the rules in [Commit messages](#commit-messages). + +## Commit messages + +We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) to standardize our commit messages. This makes it easier to generate changelogs and release notes. + +Read the [conventional commit specification](https://www.conventionalcommits.org/en/v1.0.0/#specification) for in-depth information about the commit message format. + +Most of what is written in the specification is also explained in the following sections. + +### Anatomy of a commit message + +```text +(): + + + +