Skip to content

Commit

Permalink
docs(#9): explain PR title schema
Browse files Browse the repository at this point in the history
  • Loading branch information
bossenti committed Aug 27, 2023
1 parent dbe2e6e commit eca0e16
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,3 +141,18 @@ Once you implemented your changes, please run the following commands:
just pretty # formats the code and applies automatic linting fixes
just check # checks code for conformance
```

### Opening PR

Please be aware that this repository follows [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/).
So please choose a PR title corresponding to the following:
```bash
<scope>(#<IssueID>): <description> # supported scopes can be found here: https://github.com/commitizen/conventional-commit-types/blob/master/index.json
# e.g.
docs(#8): provide extensive project readme
# issue id is optional, so the following si valid as well
docs: provide extensive project readme
```

0 comments on commit eca0e16

Please sign in to comment.