Skip to content

Commit dab3d5f

Browse files
committed
docs: add commit message convention to CONTRIBUTING.md
1 parent ce4920a commit dab3d5f

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,23 @@ go test -fuzz=FuzzBooleanEvaluation ./e2e/evaluation_fuzz_test.go
6060
```
6161
substituting the name of the fuzz as appropriate.
6262

63+
### Commit messages
64+
65+
We require commit messages and PR titles to follow the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/), meaning all titles should begin with a specifier for the type of change being made, followed by a colon, like `feat: add support for boolean flags` or `perf: improve flag evaluation times by removing time.Sleep`.
66+
67+
The full list of available types is:
68+
- `feat`: A new feature
69+
- `fix`: A bug fix
70+
- `docs`: Documentation only changes
71+
- `style`: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
72+
- `refactor`: A code change that neither fixes a bug nor adds a feature
73+
- `perf`: A code change that improves performance
74+
- `test`: Adding missing tests or correcting existing tests
75+
- `build`: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
76+
- `ci`: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
77+
- `chore`: Other changes that don't modify src or test files
78+
- `revert`: Reverts a previous commit
79+
6380
### Releases
6481

6582
This repo uses Release Please to release packages. Release Please set up a running PR that tracks all changes for the library components, and maintains the versions according to conventional commits, generated when PRs are merged.

0 commit comments

Comments
 (0)