Contributing

Contributing to urgentry

urgentry is source-available under FSL-1.1-ALv2. Contributions, bug reports, and feature requests are welcome.

Getting started

# build and test locally
git clone https://github.com/urgentry/urgentry.git
cd urgentry/apps/urgentry
make build
make test

Ways to contribute

  • Bug reports. Open an issue with reproduction steps.
  • Feature requests. Open an issue to propose ideas.
  • Code. Fork, branch, implement, test, PR. See the dev setup below.
  • Docs. Fix typos, add examples, improve guides.

Development workflow

  1. make test fast local test loop
  2. make lint go vet + golangci-lint
  3. make test-merge canonical merge gate (run before PR)
  4. make bench-pr performance regression check

Guidelines

  • Keep PRs focused — one change per PR
  • Add tests for new functionality
  • Run make test-merge before submitting
  • Update docs if behavior changes
  • Follow existing code style (gofmt + golangci-lint)