Skip to content

Latest commit

 

History

History
41 lines (26 loc) · 1.16 KB

File metadata and controls

41 lines (26 loc) · 1.16 KB

Contributing to plann

Contributions are mostly welcome (but do inform about it if you've used AI or other tools). If the length of this text scares you, then I'd rather want you to skip reading and just produce a pull-request in GitHub. If you find it too difficult to write test code, etc, then you may skip it and hope the maintainer will fix it.

What to include

Every submission should ideally include:

  • Test code covering the new behaviour or bug fix
  • Documentation updates where relevant
  • A changelog entry in CHANGELOG.md under [Unreleased]

Development setup

make dev

This installs plann in editable mode with all dev dependencies.

Running tests and linting

make test
make lint

Commit messages

Please follow Conventional Commits and write messages in the imperative mood:

  • fix: correct time-range search handling for recurring events
  • feat: add journal entry support
  • docs: update README

Rather than:

  • This commit fixes the time-range search
  • Added journal support

Note: older commits in this repository predate this convention and do not follow it.