Skip to content

Commit 29ad429

Browse files
authored
docs: added commit message guidelines to CONTRIBUTING.md (#415)
1 parent b1e8934 commit 29ad429

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

CONTRIBUTING.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,33 @@ There are a few things you might consider when filing your issue:
4646
- macOS: `~/Library/Logs/activitywatch`
4747
- Linux: `~/.cache/activitywatch/log`
4848
- Windows: `C:\Users\<USERNAME>\AppData\Local\activitywatch\activitywatch\Logs`
49+
50+
51+
## Commit message guidelines
52+
53+
When writing commit messages try to follow [Conventional Commits](https://www.conventionalcommits.org/). It is not a strict requirement (to minimize overhead for new contributors) but it is encouraged.
54+
55+
The format is:
56+
57+
```
58+
<type>[optional scope]: <description>
59+
60+
[optional body]
61+
62+
[optional footer]
63+
```
64+
65+
Where `type` can be one of: `feat, fix, chore, ci, docs, style, refactor, perf, test`
66+
67+
Examples:
68+
69+
```
70+
- feat: added ability to sort by duration
71+
- fix: fixes incorrect week number (#407)
72+
- docs: improved query documentation
73+
```
74+
75+
This guideline was adopted in [issue #391](https://github.com/ActivityWatch/activitywatch/issues/391).
4976

5077

5178
## Questions?

0 commit comments

Comments
 (0)