Skip to content

Latest commit

 

History

History
75 lines (46 loc) · 1.77 KB

File metadata and controls

75 lines (46 loc) · 1.77 KB

Contributor Guide

How to report a bug

Report bugs on the Issue Tracker.

When filing an issue, make sure to answer these questions:

  • Which operating system and Python version are you using?
  • Which version of this project are you using?
  • What did you do?
  • What did you expect to see?
  • What did you see instead?

The best way to get your bug fixed is to provide a test case, and/or steps to reproduce the issue.

How to request a feature

Request features on the Issue Tracker.

How to set up your development environment

You need Python, uv, and just installed locally. Nox is optional but required for the multi-version test matrix.

The CLI is exposed through the countdown script. Run it directly from the synced environment:

uv run countdown 6m30s

How to test the project

This project uses pytest and Ruff orchestrated through just tasks. Before opening a pull request, run the aggregated check:

just check

Useful individual commands:

just test -- -k timer
just test-cov            # pytest with coverage (fail_under=100)

Unit tests are located in the tests directory, and are written using the pytest testing framework. Open htmlcov/index.html after just test-cov to debug coverage issues.

If you need to validate across every supported Python version, run:

just test-all