Skip to content

Commit c968d3f

Browse files
committed
docs: add branch naming conventions
License: MIT Signed-off-by: Jeromy <[email protected]>
1 parent 16c5a89 commit c968d3f

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

contribute.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,14 @@ All commits in a PR must pass tests. If they don't, fix the commits and/or [squa
2828

2929
We use CI tests which run when you push to your branch. To run the tests locally, you can run any of these: `make build`, `make install`, `make test`, `go test ./...`, depending on what youre looking to do. Generally `go test ./...` is your best bet.
3030

31+
### Branch Names
32+
33+
If you are working on a new feature, prefix your branch name with `feat/`. If you are fixing an issue, `fix/`. If you are simply adding tests, `test/`. If you are adding documentation, `docs/`.
34+
35+
After that, try to signal what part of the codebase this branch is working on. For example, if you are adding a new test to the dht that tests for nil providers being returned, then `test/dht/nil-provs` would be acceptable.
36+
37+
Please also try to keep branch names around or under 20 characters. It keeps things a little cleaner overall.
38+
3139
### Commit messages
3240

3341
Commit messages must start with a short subject line, followed by an optional,

0 commit comments

Comments
 (0)