You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/docs/STYLE_GUIDE.md
+42-42
Original file line number
Diff line number
Diff line change
@@ -9,51 +9,51 @@ We use [Commitizen](https://github.com/commitizen-tools/commitizen) to manage bo
9
9
> `type(scope): description`
10
10
11
11
-**Types**
12
-
-*fix*: A bug fix
13
-
-*feat*: A new feature
14
-
-*docs*: Documentation-only changes (code comments, separate docs)
15
-
-*style*: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons)
16
-
-*perf*: A code change that improves performance
17
-
-*refactor*: A change to production code that is not a *fix*, *feat*, or *perf*
18
-
-*test*: Adding missing or correcting existing tests
19
-
-*build*: Changes that affect the build system or external dependencies
20
-
-*ci*: Changes to our CI configuration files and scripts
21
-
- A `!` can be used to indicate a breaking change (`refactor!: drop support for Node 6`)
22
-
-**SemVer Rules**
23
-
- Based on commit type, the version will be auto-incremented: `fix : PATCH // feat : MINOR // BREAKING CHANGE : MAJOR`
12
+
-*fix*: A bug fix
13
+
-*feat*: A new feature
14
+
-*docs*: Documentation-only changes (code comments, separate docs)
15
+
-*style*: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons)
16
+
-*perf*: A code change that improves performance
17
+
-*refactor*: A change to production code that is not a *fix*, *feat*, or *perf*
18
+
-*test*: Adding missing or correcting existing tests
19
+
-*build*: Changes that affect the build system or external dependencies
20
+
-*ci*: Changes to our CI configuration files and scripts
21
+
- A `!` can be used to indicate a breaking change (`refactor!: drop support for Node 6`)
22
+
-**SemVer Rules**
23
+
- Based on commit type, the version will be auto-incremented: `fix : PATCH // feat : MINOR // BREAKING CHANGE : MAJOR`
24
24
-**Scopes**
25
-
- A Class, File name, Issue Number, other appropriate noun. As examples: `build(poetry): bump requests to v3` or `style(#32): add missing type annotations`
25
+
- A Class, File name, Issue Number, other appropriate noun. As examples: `build(poetry): bump requests to v3` or `style(#32): add missing type annotations`
26
26
-**Tips**
27
-
- What if a commit fits multiple types?
28
-
- Go back and make multiple commits whenever possible. Part of the benefit of Conventional Commits is the focus on more organized and intentional changes
29
-
- Use `git rebase -i` to fix commit names prior to merging if incorrect types/scopes are used
27
+
- What if a commit fits multiple types?
28
+
- Go back and make multiple commits whenever possible. Part of the benefit of Conventional Commits is the focus on more organized and intentional changes
29
+
- Use `git rebase -i` to fix commit names prior to merging if incorrect types/scopes are used
- Full sentence with verb (*lowercase*) and concise description. Below are modified examples for Conventional Commits
35
-
-`fix(roles): bug in admin role permissions`
36
-
-`feat(ui): implement new button design`
37
-
-`build(pip): upgrade package to remove vulnerabilities`
38
-
-`refactor: file structure to improve code readability`
39
-
-`perf(cli): rewrite methods`
40
-
-`feat(api): endpoints to implement new customer dashboard`
34
+
- Full sentence with verb (*lowercase*) and concise description. Below are modified examples for Conventional Commits
35
+
- `fix(roles): bug in admin role permissions`
36
+
- `feat(ui): implement new button design`
37
+
- `build(pip): upgrade package to remove vulnerabilities`
38
+
- `refactor: file structure to improve code readability`
39
+
- `perf(cli): rewrite methods`
40
+
- `feat(api): endpoints to implement new customer dashboard`
41
41
-[How to write a good commit message](https://chris.beams.io/posts/git-commit/)
42
-
- A diff will tell you what changed, but only the commit message can properly tell you why.
43
-
- Keep in mind: [This](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)[has](https://www.git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines)[all](https://github.com/torvalds/subsurface-for-dirk/blob/master/README.md#contributing)[been](http://who-t.blogspot.co.at/2009/12/on-commit-messages.html)[said](https://github.com/erlang/otp/wiki/writing-good-commit-messages)[before](https://github.com/spring-projects/spring-framework/blob/30bce7/CONTRIBUTING.md#format-commit-messages).
44
-
- From the seven rules of a great Git commit message:
45
-
-2.[Try for 50 characters, but consider 72 the hard limit](https://chris.beams.io/posts/git-commit/#limit-50)
46
-
-7.[Use the body to explain what and why vs. how](https://chris.beams.io/posts/git-commit/#why-not-how)
42
+
- A diff will tell you what changed, but only the commit message can properly tell you why.
43
+
- Keep in mind: [This](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)[has](https://www.git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines)[all](https://github.com/torvalds/subsurface-for-dirk/blob/master/README.md#contributing)[been](http://who-t.blogspot.co.at/2009/12/on-commit-messages.html)[said](https://github.com/erlang/otp/wiki/writing-good-commit-messages)[before](https://github.com/spring-projects/spring-framework/blob/30bce7/CONTRIBUTING.md#format-commit-messages).
44
+
- From the seven rules of a great Git commit message:
45
+
- (2)[Try for 50 characters, but consider 72 the hard limit](https://chris.beams.io/posts/git-commit/#limit-50)
46
+
- (7)[Use the body to explain what and why vs. how](https://chris.beams.io/posts/git-commit/#why-not-how)
47
47
48
48
### Issue Labels and Milestones
49
49
50
50
Personal Guide
51
51
52
-
- For Issue Labels, see [labels.yml][labels]
52
+
- For Issue Labels, see \[labels.yml\]\[labels\]
53
53
- Milestones
54
-
-**Current Tasks**: main milestone (*name could change based on a specific project, sprint, or month*)
55
-
-**Next Tasks**
56
-
-**Blue Sky**
54
+
-**Current Tasks**: main milestone (*name could change based on a specific project, sprint, or month*)
55
+
-**Next Tasks**
56
+
-**Blue Sky**
57
57
58
58
<details>
59
59
<summary>Research</summary>
@@ -127,25 +127,25 @@ Personal Guide
127
127
128
128
<!-- Revisit -->
129
129
130
-
-[Git: The Simple Guide][simple_git]
131
-
-[Commit Messages][gcmsg] and [why use the present tense](https://news.ycombinator.com/item?id=8874177)
130
+
-\[Git: The Simple Guide\]\[simple_git\]
131
+
-\[Commit Messages\]\[gcmsg\] and [why use the present tense](https://news.ycombinator.com/item?id=8874177)
132
132
-[GitHub's Advice on GitHub](https://github.com/erlang/otp/wiki/Writing-good-commit-messages)
0 commit comments