Skip to content

Latest commit

 

History

History
28 lines (18 loc) · 1007 Bytes

CONTRIBUTING.md

File metadata and controls

28 lines (18 loc) · 1007 Bytes

Contributing to Snapif

Human contributors can start here. AGENTS.md is for coding agents.

Where to start

Look at good first issues and help wanted.

Setup

git clone https://github.com/snapif/snapif.git
cd snapif
make check

make check is the local gate: format, clippy, tests, deny, and workflow lint.

Pull requests

  • Use a conventional title: feat:, fix:, docs:, chore:, test:, ci:, refactor:, perf:, style:, or build:.
  • Sign every commit with git commit -s. The sign-off email is git config user.email.
  • Do not add a bline-*, canact, wiremux, or wiremux-auth dependency.
  • A release pull request publishes the crate. Leave it for a maintainer to merge.

Reporting

Use the issue templates. For a vulnerability, follow SECURITY.md.