Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
48 lines (33 loc) · 796 Bytes

CONTRIBUTING.md

File metadata and controls

48 lines (33 loc) · 796 Bytes

Contributing

Prerequisites

  • mise
  • git
  • make

Setup

mise trust .mise.toml
mise install
mise exec -- make setup

Local workflow

Run app:

mise exec -- make run

Run checks before opening a PR:

mise exec -- make fmt
mise exec -- make check

Smoke tests for deployed endpoint

BASE_URL=https://YOUR_DOMAIN_OR_FUNCTION_URL mise exec -- make smoke

Pull requests

  • Keep changes focused and small.
  • Include tests for behavioral changes.
  • Update README.md when API behavior changes.

Dependency maintenance

  • Dependabot PRs (gomod, github-actions) are reviewed weekly.
  • Merge only with passing CI checks.
  • For failing dependency PRs, push a fix commit to the PR branch or replace it with a clean follow-up PR.