Skip to content

Commit

Permalink
docs: improve contribution guide
Browse files Browse the repository at this point in the history
  • Loading branch information
DavidPL1 committed Nov 7, 2024
1 parent 40ca5ac commit a34e23c
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,16 @@ If not, please create a new issue.
```sh
git checkout -b add-featureX
```
or
```sh
git checkout -b fix-bugX
```

* As you code, commit your changes (following conventional commits style, the commit template will help you with that).
pre-commit will automatically run clang-format and clang-tidy and make sure your commit message conforms with our template.

* Write tests using Google Tests to test your code.
In case your contribution is a bugfix, add or improve a test to catch the bug before the fix is applied. This ensures resurfacing of the bug due to later code changes is caught.

5. Propose changes via Pull Requests

Expand Down

0 comments on commit a34e23c

Please sign in to comment.