Skip to content

Commit a72561b

Browse files
committed
docs: add format instructions
1 parent 35dd66b commit a72561b

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

SEMANTIC_VERSIONING.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,21 @@
11
# Semantic Versioning Guide
22

3+
See [Conventional Commits](https://www.conventionalcommits.org/)
4+
5+
As an open-source maintainer, squash feature branches onto master and write a standardized commit message while doing so. The commit message should be structured as follows:
6+
7+
```code
8+
<type>: This represents the type of change made in the commit. Common types include feat (for a new feature), fix (for a bug fix), chore (for routine tasks like updating dependencies), docs (for documentation changes), style (for code style changes), refactor (for refactoring existing code), test (for adding or updating tests), and perf (for performance improvements).
9+
10+
[optional scope]: This is an optional part that provides additional contextual information, like the part of the codebase the commit modifies.
11+
12+
<description>: This is a brief description of the changes the commit makes.
13+
14+
[optional body]: This is an optional part where you can provide a more detailed explanation of the changes.
15+
16+
[optional footer(s)]: This is also optional and is often used to reference issue tracker IDs.
17+
```
18+
319
## Commit Message format
420

521
- `feat`: A new feature

0 commit comments

Comments
 (0)