Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
116 lines (74 loc) · 1.96 KB

CONTRIBUTING.md

File metadata and controls

116 lines (74 loc) · 1.96 KB

Contributing to Bkper CLI

Thanks for contributing to bkper-cli.

This guide covers the day-to-day development flow and the release automation policy used in this repository.

Development setup

  • Node.js: >=18
  • Package manager: bun

Install dependencies:

bun install

Run local checks:

bun run build
bun run test:unit

Daily coding workflow

  1. Sync main
git checkout main
git pull
  1. Create a short-lived branch
git checkout -b <type>/<short-description>

Examples:

  • fix/auth-refresh-error
  • feat/transaction-batch-filter
  • chore/update-dependencies
  1. Make small, focused changes
  • Keep each PR scoped to one problem.
  • Prefer incremental changes over large refactors.
  1. Run checks locally before opening PR
bun run build
bun run test:unit
  1. Open PR to main
  • Wait for CI to pass.
  • Address review feedback.
  • Merge when green.

Release workflow

Releases are automated and tag-driven.

  1. Start from a clean, up-to-date main
  2. Run one of:
bun run release:patch
bun run release:minor
bun run release:major
  1. Push the release commit and tag:
git push origin main --follow-tags

GitHub Actions publishes only from version tags matching v*.*.*. Dependabot PRs stay standard dependency PRs; Pi bumps may be auto-merged if checks pass.

CI expectations

PRs are expected to pass:

  • Build
  • Unit tests

Keep your branch up to date with main if checks fail due to drift.

Commit and PR quality

  • Use clear commit messages.
  • Describe user impact in PR description.
  • Include reasoning for non-obvious decisions.
  • Keep changelog/user-facing docs focused on user-relevant changes.

Security and publishing

Publishing uses npm Trusted Publishers (OIDC) via GitHub Actions.

Do not add long-lived npm publish tokens to workflows unless explicitly required as an emergency fallback.