From 31235dcd04f714ec908c414e3808ac6379f36723 Mon Sep 17 00:00:00 2001 From: Daniel Lockyer Date: Thu, 13 Oct 2022 09:56:14 +0700 Subject: [PATCH] Improved commit message docs in contributing guide - `refs/closes` can be confusing to those who are not familiar with GitHub when we actually mean "use refs or fixes (or closes)" - we generally don't want to use emojis for alpha features because adding it to the release notes is unnecessary until the feature is GA --- .github/CONTRIBUTING.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 2cc4bc4c14..303ce4d8aa 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -33,11 +33,10 @@ We have a handful of simple standards for commit messages which help us to gener - **1st line:** Max 80 character summary written in past tense - **2nd line:** [Always blank] -- **3rd line:** `refs/closes #000` or `no issue` +- **3rd line:** `refs `, `fixes ` or `no issue` - **4th line:** Why this change was made - the code includes the what, the commit message should describe the context of why - why this, why now, why not something else? -If your change is **user-facing** please prepend the first line of your commit with **an emoji key**. -We are following [gitmoji](https://gitmoji.carloscuesta.me/). +If your change is **user-facing** please prepend the first line of your commit with **an emoji key**. If the commit is for an alpha feature, no emoji is needed. We are following [gitmoji](https://gitmoji.carloscuesta.me/). **Main emojis we are using:**