Skip to content

Commit d795f10

Browse files
authored
feat: commit styling guide
1 parent 51dd856 commit d795f10

File tree

1 file changed

+69
-9
lines changed

1 file changed

+69
-9
lines changed

.github/CONTRIBUTING.md

Lines changed: 69 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,72 @@ 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
47-
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]`
53-
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.
46+
## Git Commit Styling
47+
48+
Not following this guideline could lead to your pull being squashed for a cleaner commit history
49+
50+
This style guide is most based of the [conventional commits](https://www.conventionalcommits.org/) style guide, in where it follows following guidelines:
51+
```txt
52+
type(scope): <description>
53+
```
54+
different with conventional commits is that we are gonna be defining the types you can use.
55+
56+
### Normal Types
57+
58+
These here are some types normally used without the library
59+
60+
#### Feature Types:
61+
```
62+
feat:
63+
feature:
64+
addition:
65+
creation:
66+
```
67+
#### Bug Fix Types:
68+
```
69+
fix:
70+
bug:
71+
bug-fix:
72+
```
73+
#### Fixing Grammar Mistakes:
74+
```
75+
typo:
76+
grammar:
77+
nit:
78+
```
79+
#### When refactoring or efficientizing code:
80+
```
81+
speed:
82+
refactor:
83+
efficent:
84+
```
85+
86+
### Extension Types
87+
88+
Some types used in the `ext`'s
89+
90+
#### ommands Types:
91+
```
92+
ext.commands:
93+
commands.Bot
94+
checks:
95+
cogs:
96+
cooldowns:
97+
```
98+
#### ages Types:
99+
```
100+
ext.pages:
101+
pages:
102+
paginator:
103+
```
104+
Tasks Types:
105+
```
106+
ext.tasks:
107+
tasks:
108+
```
109+
110+
### Displaying breaking changes or closing issues in a commit
111+
When closing issues or displaying a breaking change just add the following to your extended description:
112+
```
113+
BREAKING CHANGE:
114+
CLOSES: #<issue-number>

0 commit comments

Comments
 (0)