Skip to content

Commit bc5929f

Browse files
committed
docs: use conventional commits
1 parent 6d86f50 commit bc5929f

File tree

1 file changed

+4
-14
lines changed

1 file changed

+4
-14
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -119,25 +119,15 @@ mkdocs build --strict
119119

120120
## Commit Message
121121

122-
Read
123-
[Git Contribution Guidelines](https://git-scm.com/docs/SubmittingPatches#describe-changes).
124-
125-
In a nutshell:
126-
127-
- **First Line**: `component: description of the patch` in all lowercase
128-
unless it's in a cap in the code.
129-
- **Body**: In 2-3 paragraphs:
130-
1. the current problem you want to solve
131-
2. justification of your change
132-
3. if any, alternative solutions considered but discarded
122+
Follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
133123

134124
## Pull Request Style
135125

136-
1. **Title**: Follow the First Line rule of [Commit Message](#commit-message).
137-
2. **Description**: Follow the Body rule of [Commit Message](#commit-message).
126+
1. **Title**: Follow Conventional Commits.
127+
2. **Description**: Follow Conventional Commits.
138128
3. **CI**: Verify that all CI checks pass on your fork before submitting the
139129
PR. Avoid relying on the CI of this repository to catch errors, as this
140130
can cause delays or stalls for other contributors.
141-
4. **Commits**: There is no need to squash commits within the PR
131+
4. **Commits**: There is no need to squash / force push commits within the PR
142132
unless explicitly requested. Keeping separate commits can help reviewers
143133
understand the progression of changes.

0 commit comments

Comments
 (0)