Skip to content

Commit 09c96e4

Browse files
committed
docs(contributing): Use Conventional Commits
The StGit project is adopting the Conventional Commits[1] conventions for commit messages. The goal is to make StGit's changelog easier to compile and understand. [1]: https://www.conventionalcommits.org/
1 parent f3b0710 commit 09c96e4

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,13 +58,12 @@ Code changes for bug fixes and features should be submitted as [pull
5858
requests][PR] to the [stgit repository][stgit-repo] on GitHub, with the
5959
following guidelines:
6060

61-
[PR]: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests
62-
[stgit-repo]: https://github.com/stacked-git/stgit
63-
6461
- Test cases! Please add test cases to the test suite in the `t`
6562
directory to verify any new or changed StGit behaviors. And run `make
6663
test` to ensure the test suite passes.
6764

65+
- Use [Conventional Commit][conventional-commit] style commit messages.
66+
6867
- Add a `Signed-off-by:` trailer to each commit message to indicate that
6968
certifies that you wrote or otherwise have the right to contribute the
7069
patch as open-source, according to the [Developers Certificate of
@@ -74,6 +73,10 @@ following guidelines:
7473
- Lint. Run `make lint` to ensure that the code meets the project's
7574
syntactic standards and passes static checks.
7675

76+
[PR]: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests
77+
[stgit-repo]: https://github.com/stacked-git/stgit
78+
[conventional-commit]: https://www.conventionalcommits.org/
79+
7780
### Developer's Certificate of Origin 1.1
7881

7982
By making a contribution to this project, I certify that:
@@ -106,7 +109,8 @@ By making a contribution to this project, I certify that:
106109
- Each commit (patch) addresses a coherent topic.
107110
- `make lint` passes.
108111
- No commented-out code or unneeded files in commits.
109-
- Each commit has a meaningful commit message.
112+
- Each commit has a meaningful commit message using the [Conventional
113+
Commit][conventional-commit] style.
110114
- Each commit has a `Signed-off-by: Your Name <[email protected]` trailer.
111115
- Tests are added/modified that cover the bug fix or feature being
112116
added.

0 commit comments

Comments
 (0)