@@ -58,13 +58,12 @@ Code changes for bug fixes and features should be submitted as [pull
58
58
requests] [ PR ] to the [ stgit repository] [ stgit-repo ] on GitHub, with the
59
59
following guidelines:
60
60
61
- [ PR ] : https://help.github.com/en/github/collaborating-with-issues-and-pull-requests
62
- [ stgit-repo ] : https://github.com/stacked-git/stgit
63
-
64
61
- Test cases! Please add test cases to the test suite in the ` t `
65
62
directory to verify any new or changed StGit behaviors. And run `make
66
63
test` to ensure the test suite passes.
67
64
65
+ - Use [ Conventional Commit] [ conventional-commit ] style commit messages.
66
+
68
67
- Add a ` Signed-off-by: ` trailer to each commit message to indicate that
69
68
certifies that you wrote or otherwise have the right to contribute the
70
69
patch as open-source, according to the [ Developers Certificate of
@@ -74,6 +73,10 @@ following guidelines:
74
73
- Lint. Run ` make lint ` to ensure that the code meets the project's
75
74
syntactic standards and passes static checks.
76
75
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
+
77
80
### Developer's Certificate of Origin 1.1
78
81
79
82
By making a contribution to this project, I certify that:
@@ -106,7 +109,8 @@ By making a contribution to this project, I certify that:
106
109
- Each commit (patch) addresses a coherent topic.
107
110
- ` make lint ` passes.
108
111
- 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.
110
114
- Each commit has a
` Signed-off-by: Your Name <[email protected] ` trailer.
111
115
- Tests are added/modified that cover the bug fix or feature being
112
116
added.
0 commit comments