Skip to content

Commit 4b65859

Browse files
author
y-p
committed
Merge pull request #3160 from danbirken/commit_prefix_explain
DOC: Add more detailed description of commit prefixes
2 parents 9ceffb8 + 39be803 commit 4b65859

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

CONTRIBUTING.md

+9-2
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,15 @@ your contribution or address the issue you're having.
3434
This can create all sorts of problems. Use "git rebase" instead. This ensures
3535
no merge conflicts occur when you're code is merged by the core team.
3636
- An informal commit message format is in effect for the project, please try
37-
and adhere to it. Use a "ENH: ", "TST:", "BUG:", "DOC:", etc' prefix in
38-
your commit title. Check the output of "git log" for examples.
37+
and adhere to it. View "git log" for examples. Here are some common prefixes
38+
along with general guidelines for when to use them:
39+
- ENH: Enhancement, new functionality
40+
- BUG: Bug fix
41+
- DOC: Additions/updates to documentation
42+
- TST: Additions/updates to tests
43+
- BLD: Updates to the build process/scripts
44+
- PERF: Performance improvement
45+
- CLN: Code cleanup
3946
- RELEASE.rst and doc/source/vx.y.z.txt contain an on-going changelog for each
4047
release as it is worked on. Add entries to these files as needed in
4148
a separate commit in your PR, documenting the fix, enhancement or (unavoidable)

0 commit comments

Comments
 (0)