Skip to content

Commit c2eb5af

Browse files
authored
docs: add PR title and DCO rules to CONTRIBUTING.md (#321)
Signed-off-by: Eli Treuherz <[email protected]>
1 parent 44a74c3 commit c2eb5af

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

CONTRIBUTING.md

+34
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,40 @@ go test -fuzz=FuzzBooleanEvaluation ./e2e/evaluation_fuzz_test.go
6060
```
6161
substituting the name of the fuzz as appropriate.
6262

63+
### Opening a Pull Request
64+
65+
#### Titles
66+
67+
We require 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`.
68+
69+
The full list of available types is:
70+
- `feat`: A new feature
71+
- `fix`: A bug fix
72+
- `docs`: Documentation only changes
73+
- `style`: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
74+
- `refactor`: A code change that neither fixes a bug nor adds a feature
75+
- `perf`: A code change that improves performance
76+
- `test`: Adding missing tests or correcting existing tests
77+
- `build`: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
78+
- `ci`: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
79+
- `chore`: Other changes that don't modify src or test files
80+
- `revert`: Reverts a previous commit
81+
82+
#### Developer Certificate of Origin
83+
84+
The [Developer Certificate of Origin (DCO)](https://developercertificate.org/) is a lightweight way for contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project.
85+
To sign off that they adhere to these requirements, all commits need to have a `Signed-off-by` line, like:
86+
87+
```
88+
fix: solve all the problems
89+
90+
Signed-off-by: John Doe <[email protected]>
91+
```
92+
93+
This is easy to add by using the [`-s`/`--signoff`](https://git-scm.com/docs/git-commit#Documentation/git-commit.txt--s) flag to `git commit`.
94+
95+
More info is available in the [OpenFeature community docs](https://openfeature.dev/community/technical-guidelines/#developer-certificate-of-origin).
96+
6397
### Releases
6498

6599
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)