File tree 1 file changed +27
-0
lines changed
1 file changed +27
-0
lines changed Original file line number Diff line number Diff line change 1
1
# Contributing
2
2
3
+ ## Commit subjects
4
+
5
+ Commit subjects are used to determine whether a commit will show up in
6
+ the ` CHANGELOG.md ` , and under what section.
7
+
8
+ Commit subjects that don't follow the following pattern will not be
9
+ included in the ` CHANGELOG.md ` :
10
+
11
+ - ` type: free form subject `
12
+
13
+ Where ` type ` can be:
14
+
15
+ * ` feat ` : used by commits introducing a new feature
16
+ * ` fix ` : used by commits fix an issue
17
+ * ` perf ` : used by commits improving performance
18
+ * ` refactor ` : used by commits doing some code refactoring
19
+
20
+ Some examples:
21
+
22
+ - ` feat: this is a new feature `
23
+ - ` fix: this is fixing a reported bug `
24
+
25
+ It's also possible to specify a component if this commit targets one
26
+ component specifically.
27
+
28
+ - ` feat(resolver): this adds a new solver strategy `
29
+
3
30
## Tagging a new release
4
31
5
32
### Create a new tag
You can’t perform that action at this time.
0 commit comments