Skip to content

Latest commit

 

History

History
26 lines (23 loc) · 1.24 KB

File metadata and controls

26 lines (23 loc) · 1.24 KB

Contributing

There are only a few rules:

  1. Follow the commit convention
    • Conventional Commits: <type>(<scope>): <description>
    • Types: feat, fix, chore, refactor, docs, test
    • Lowercase, no markdown styling, no trailing period
    • Never include AI attribution (Generated by Claude, Made by AI, etc.)
    • Look at existing commits for scope conventions I use
  2. Format your code
    • Run make -C Linux fmt before committing (Go + Nix + shell)
    • Match the existing style: no trailing whitespace, single spaces around operators
  3. No AI slop allowed
    • AI-generated readme/docs = instant block
    • AI-assisted code is fine if you reviewed and own it
  4. PLEASE TEST YOUR PRS
    • make -C Linux all must pass for any change under Linux/**
    • Windows changes: test on a real Windows host or VM
    • Your PR must not break anything currently existing, or specify in the description if it does
  5. PR descriptions should be descriptive
    • Use the template: ## What / ## Why / ## Testing
    • Explain what the PR does and how to use it
    • Include any breaking changes and side effects

Security issues: do not open a public issue. See SECURITY.md.