From 2a268f6d0bf55ac076511a6613dfb011259760d1 Mon Sep 17 00:00:00 2001 From: Gary Ewan Park Date: Mon, 1 Mar 2021 07:16:27 +0000 Subject: [PATCH] (doc) Update to prefer # rather than GH- GH- is specific to GitHub, where as, # works across different version control systems, so it makes sense to get into the habit of using something that works everywhere. --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ae52677714..3d0caab8d0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -223,7 +223,7 @@ A commit should observe the following: A commit message should observe the following (based on ["A Note About Git Commit Messages"](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)): - * The first line of the commit message should be a short description around 50 characters in length and be prefixed with the GitHub issue it refers to with parentheses surrounding that. If the GitHub issue is #25, you should have `(GH-25)` prefixed to the message. + * The first line of the commit message should be a short description around 50 characters in length and be prefixed with the GitHub issue it refers to with parentheses surrounding that. If the GitHub issue is #25, you should have `(#25)` prefixed to the message. **NOTE:** Previously, the requirement was to use something like `(GH-25)` in commit messages, however, that approach has been deprecated. * If the commit is about documentation, the message should be prefixed with `(doc)`. * If it is a trivial commit or one of formatting/spaces fixes, it should be prefixed with `(maint)`. * After the subject, skip one line and fill out a body if the subject line is not informative enough. @@ -236,7 +236,7 @@ A commit message should observe the following (based on ["A Note About Git Commi A good example of a commit message is as follows: ``` -(GH-7) Installation Adds All Required Folders +(#7) Installation Adds All Required Folders Previously the installation script worked for the older version of Chocolatey. It does not work similarly for the newer version of choco