Skip to content

Commit d5d044e

Browse files
authored
Merge pull request #5 from infobloxopen/docs/dco-policy
docs: document DCO enforcement policy and conventional commits
2 parents 86b3a9e + c85cb2d commit d5d044e

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -110,12 +110,16 @@ mypy src/dns_aid
110110

111111
### Commit Message Guidelines
112112

113-
Use clear, descriptive commit messages:
114-
- `Add: new feature description`
115-
- `Fix: bug description`
116-
- `Update: what was changed`
117-
- `Remove: what was removed`
118-
- `Refactor: what was refactored`
113+
We follow [Conventional Commits](https://www.conventionalcommits.org/):
114+
115+
```
116+
feat: add DANE certificate matching support
117+
fix: Route53 SVCB custom param demotion to TXT records
118+
chore: bump version to 0.6.0
119+
docs: update architecture diagram
120+
```
121+
122+
All commits **must** include a DCO sign-off (see below).
119123

120124
## Pull Request Guidelines
121125

@@ -149,11 +153,13 @@ This project uses the [Developer Certificate of Origin](https://developercertifi
149153
By submitting a patch, you agree to the DCO. All commits must include a `Signed-off-by` line:
150154

151155
```bash
152-
git commit -s -m "Your commit message"
156+
git commit -s -m "feat: your commit message"
153157
```
154158

155159
This certifies that you wrote or have the right to submit the code under the project's open-source license.
156160

161+
> **Note:** DCO sign-off enforcement has been active since v0.6.0. All pull requests are automatically checked by the DCO workflow, and branch protection requires it to pass before merging.
162+
157163
## License
158164

159165
By contributing, you agree that your contributions will be licensed under the Apache 2.0 License.

0 commit comments

Comments
 (0)