Skip to content

Commit

Permalink
docs(contributing): additional instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
ddkasa committed Oct 15, 2024
1 parent 7c2e86f commit cbc352e
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@

- Lint with `ruff toggl_api`
- Check typing with `mypy toggl_api`
- Make sure to install pre-commit hook with `pre-commit install`.

## Testing

Expand All @@ -30,4 +31,5 @@

## Documentation

- Run `mkdocs serve --strict` to preview documentation
- Run `mkdocs serve --strict` to build and preview documentation
- Run `git cliff -o docs/CHANGELOG.md` to generate new changelog. _Requires git-cliff to be installed._

0 comments on commit cbc352e

Please sign in to comment.