Skip to content

Commit

Permalink
docs(README): Add description about PR checks
Browse files Browse the repository at this point in the history
Reported with PR comments there: #228

Change-Id: Id0ae60e226456818ff9a5421f839eeb287de4f63
Signed-off-by: Florent BENOIT <fbenoit@redhat.com>
  • Loading branch information
benoitf committed Jul 22, 2019
1 parent 2942905 commit 3f36ffa
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <chectl@eclipse.org>
```

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.

0 comments on commit 3f36ffa

Please sign in to comment.