From 39be803bf0c3d5d226be8cf3a6caa9c0c895b662 Mon Sep 17 00:00:00 2001 From: Dan Birken Date: Sun, 24 Mar 2013 13:47:24 -0700 Subject: [PATCH] DOC: Add more detailed description of commit prefixes --- CONTRIBUTING.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9f4e30817d7ed..6bc5700c49866 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -34,8 +34,15 @@ your contribution or address the issue you're having. This can create all sorts of problems. Use "git rebase" instead. This ensures no merge conflicts occur when you're code is merged by the core team. - An informal commit message format is in effect for the project, please try - and adhere to it. Use a "ENH: ", "TST:", "BUG:", "DOC:", etc' prefix in - your commit title. Check the output of "git log" for examples. + and adhere to it. View "git log" for examples. Here are some common prefixes + along with general guidelines for when to use them: + - ENH: Enhancement, new functionality + - BUG: Bug fix + - DOC: Additions/updates to documentation + - TST: Additions/updates to tests + - BLD: Updates to the build process/scripts + - PERF: Performance improvement + - CLN: Code cleanup - RELEASE.rst and doc/source/vx.y.z.txt contain an on-going changelog for each release as it is worked on. Add entries to these files as needed in a separate commit in your PR, documenting the fix, enhancement or (unavoidable)