diff --git a/README.md b/README.md index b9ba537f2..185b89378 100644 --- a/README.md +++ b/README.md @@ -381,3 +381,25 @@ Package the binary yarn pack pkg . -t node10-linux-x64,node10-macos-x64,node10-win-x64 --out-path ./bin/ ``` + +## Providing Pull Request +`chectl` is using several Pull Request checks + - [Conventional Commits](https://conventionalcommits.org) convention for the commit messages. +There is a required Pull Request check named `Semantic Pull Request` that is ensuring that all commits messages are correctly setup. In order to merge a Pull Request, it has to be green. + +- Signed Commits. Each commit needs to have the `Signed-off` part +It needs to be added on the commit message: +``` +feat(hello): This is my first commit message + +Signed-off-by: John Doe +``` + +Git even has a -s command line option to append this automatically to your commit message: +``` +$ git commit -s -m 'feat(hello): This is my first commit message' +``` + +- Unit tests with Travis-CI. It will ensure that `yarn test` command is passing. + +All these checks are mandatory in order to have the Pull Request merged.