Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
82 lines (60 loc) · 2.25 KB

CONTRIBUTING.md

File metadata and controls

82 lines (60 loc) · 2.25 KB
Raw

Contributing

Development setup

git clone git@github.com:dualentry/dualentry-cli.git
cd dualentry-cli
uv sync --dev
uv run pre-commit install

Dependencies

uv.lock is committed, and CI runs uv sync --dev --locked, which fails if the lockfile is out of date with pyproject.toml. So whenever you add, remove, or change a dependency:

uv lock          # regenerate uv.lock

Commit the updated uv.lock alongside your pyproject.toml change, or CI will fail with The lockfile at uv.lock needs to be updated, but --locked was provided.

To pick up newer versions of existing dependencies, run uv lock --upgrade deliberately — it is not something that happens on its own. Expect to fix new ruff findings when you do, since the lint config selects ALL rules and each ruff release can add more.

Running locally

uv run dualentry --help
uv run dualentry invoices list

Linting

uv run ruff check .
uv run ruff format --check .

Tests

uv run pytest
uv run pytest --cov=dualentry_cli --cov-report=term-missing

Pull requests

  1. Create a branch from main
  2. Make your changes
  3. Ensure linting and tests pass
  4. If you touched dependencies, run uv lock and commit uv.lock
  5. Open a PR against main

Releasing

Releases are triggered by publishing a GitHub Release. CI builds binaries and updates the Homebrew tap automatically.

  1. Update CHANGELOG.md with the new version and changes
  2. Commit and push to main
  3. Go to GitHub → Releases → Draft a new release
  4. Click Choose a tag → type the new version (e.g., v0.2.0) → Create new tag
  5. Set the title: DualEntry CLI v0.2.0 — <summary>
  6. Paste the changelog entry as the release body
  7. Click Publish release

CI will:

  • Build binaries for macOS (arm64, x86_64) and Linux (x86_64)
  • Stamp the version from the tag into the binary
  • Upload binaries to the GitHub Release
  • Update the Homebrew tap formula with new SHA256 hashes

Users upgrade via brew upgrade dualentry or re-running the install script.

Versioning

We use Semantic Versioning:

  • Patch (0.1.1) — bug fixes
  • Minor (0.2.0) — new features, backward compatible
  • Major (1.0.0) — breaking changes