OpenSourceArk
/
Ghost
mirror of https://github.com/TryGhost/Ghost.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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
This commit is contained in:
Daniel Lockyer 2022-10-13 09:56:14 +07:00 committed by GitHub
parent 143ae857c9
commit 31235dcd04
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
.github/CONTRIBUTING.md vendored
View File

@ -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 <issue link>`, `fixes <issue link>` 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:**