Skip to content

Commit 4af1bb1

Browse files
docs: Update commit documentation
1 parent b524d3c commit 4af1bb1

File tree

1 file changed

+17
-11
lines changed

1 file changed

+17
-11
lines changed

.github/CODESTYLE.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -57,21 +57,27 @@ class ExampleClass:
5757

5858

5959
## Commit Message Guidelines
60-
When committing, commit messages are prefixed with a `+` or `-`. Depending on the type of change made
61-
influences which prefix is used.
62-
63-
- `+` when something is added.
64-
- `-` when something is removed.
65-
- none: when neither is applicable, like merge commits.
60+
When committing, commit messages are prefixed with one of the following depending on the type of change made.
61+
62+
- `feat:` when a new feature is introduced with the changes.
63+
- `fix:` when a bug fix has occurred.
64+
- `chore:` for changes that do not relate to a fix or feature and do not modify *source* or *tests*. (like updating dependencies)
65+
- `refactor:` for refactoring code that neither fixes a bug nor adds a feature.
66+
- `docs:` when changes are made to documentation.
67+
- `style:` when changes that do not affect the code, but modify formatting.
68+
- `test:` when changes to tests are made.
69+
- `perf:` for changes that improve performance.
70+
- `ci:` for changes that affect CI.
71+
- `build:` for changes that affect the build system or external dependencies.
72+
- `revert:` when reverting changes.
6673

6774
Commit messages are also to begin with an uppercase character. Below list some example commit messages.
6875

76+
```sh
77+
git commit -m "docs: Added README.md"
78+
git commit -m "revert: Removed README.md"
79+
git commit -m "docs: Moved README.md"
6980
```
70-
git commit -m "+ Added README.md"
71-
git commit -m "- Removed README.md"
72-
git commit -m "Moved README.md"
73-
```
74-
7581

7682

7783
## Markdown Guidelines

0 commit comments

Comments
 (0)