Navigation Menu

Skip to content

Commit

Permalink
docs: added commit message guidelines to CONTRIBUTING.md (#415)
Browse files Browse the repository at this point in the history
  • Loading branch information
ErikBjare committed Apr 19, 2020
1 parent b1e8934 commit 29ad429
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions CONTRIBUTING.md
Expand Up @@ -46,6 +46,33 @@ There are a few things you might consider when filing your issue:
- macOS: `~/Library/Logs/activitywatch`
- Linux: `~/.cache/activitywatch/log`
- Windows: `C:\Users\<USERNAME>\AppData\Local\activitywatch\activitywatch\Logs`


## Commit message guidelines

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.

The format is:

```
<type>[optional scope]: <description>
[optional body]
[optional footer]
```

Where `type` can be one of: `feat, fix, chore, ci, docs, style, refactor, perf, test`

Examples:

```
- feat: added ability to sort by duration
- fix: fixes incorrect week number (#407)
- docs: improved query documentation
```

This guideline was adopted in [issue #391](https://github.com/ActivityWatch/activitywatch/issues/391).


## Questions?
Expand Down

0 comments on commit 29ad429

Please sign in to comment.