Skip to content

Commit 363b94f

Browse files
authored
Merge pull request #653 from pycord/style-guide
Commit Styling
2 parents 2f0c251 + 4d254c9 commit 363b94f

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

.github/CONTRIBUTING.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,14 @@ deciding to ignore type checking warnings.
4343

4444
By submitting a pull request, you agree that; 1) You hold the copyright on all submitted code inside said pull request; 2) You agree to transfer all rights to the owner of this repository, and; 3) If you are found to be in fault with any of the above, we shall not be held responsible in any way after the pull request has been merged.
4545

46-
### Git Commit Guidelines
46+
## Git Commit Styling
4747

48-
- Use present tense (e.g. "Add feature" not "Added feature")
49-
- Limit all lines to 72 characters or less.
50-
- Reference issues or pull requests outside of the first line.
51-
- Please use the shorthand `#123` and not the full URL.
52-
- Commits regarding the commands extension must be prefixed with `[commands]`
48+
Not following this guideline could lead to your pull being squashed for a cleaner commit history
5349

54-
If you do not meet any of these guidelines, don't fret. Chances are they will be fixed upon rebasing but please do try to meet them to remove some of the workload.
50+
Some style guides we would recommed using in your pulls:
51+
52+
The [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) style is a very widely used style and a good style to start with.
53+
54+
The [gitmoji](https://gitmoji.dev) style guide would make your pull look more lively and different to others.
55+
56+
We don't limit nor deny your pulls when you're using another style although, please make sure it is appropriate and makes sense in this library.

0 commit comments

Comments
 (0)