Skip to content

Commit

Permalink
chore(docs): contributing updated with branch name convention [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
HugoDelatte committed Dec 29, 2023
1 parent 06a5755 commit b678be7
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,14 @@ Ready to contribute? Here's how to set yourself up for local development.
```shell
$ git checkout -b name-of-your-bugfix-or-feature
```

Now you can make your changes locally.

To name your branch, you can use the convention:
`category/reference/description-in-kebab-case`
with category: `feat`, `fix`, `refactor`, `chore` and reference:
`issue-<issue number>` or `no-ref`. For example: `feature/issue-34/factor-model`


5. Add unit tests for your implementation and check that your changes pass all tests:

```shell
Expand Down

0 comments on commit b678be7

Please sign in to comment.