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: CONTRIBUTING.md
+46-11Lines changed: 46 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,20 +14,46 @@ Thank you for your interest in contributing. This document gives a short overvie
14
14
15
15
Before submitting, please read our [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you agree to uphold it.
16
16
17
+
## Development setup
18
+
19
+
This repository uses [pre-commit](https://pre-commit.com/) hooks to enforce code quality checks before each commit. Set it up once after cloning:
20
+
21
+
```bash
22
+
pip install pre-commit
23
+
pre-commit install --install-hooks
24
+
```
25
+
26
+
After this, every `git commit` will automatically validate your commit message format (see below).
27
+
17
28
## Commit message conventions
18
29
19
-
We encourage [Conventional Commits](https://www.conventionalcommits.org/) so that history and release notes stay clear.
30
+
This repository enforces the [Conventional Commits](https://www.conventionalcommits.org/) specification via a pre-commit hook. Commits that don't follow this format will be rejected.
31
+
32
+
### Format
33
+
34
+
```
35
+
<type>(optional scope): <description>
36
+
37
+
[optional body]
20
38
21
-
Use one of these prefixes at the start of your commit message:
0 commit comments