Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
46 lines (31 loc) · 1.35 KB

CONTRIBUTING.md

File metadata and controls

46 lines (31 loc) · 1.35 KB

Contributing

We welcome contributions! Please follow these guidelines:

Issues

  • Search existing issues before opening a new one
  • Use issue templates (bug report, feature request)
  • Provide reproducible steps for bugs

Pull Requests

  1. Fork the repo and create a branch: git checkout -b my-feature
  2. Make changes; ensure cargo test and npm test pass
  3. Write clear commit messages (conventional commits preferred):
    • feat: add QUIC transport option
    • fix: resolve SSE reconnect race condition
    • docs: update mTLS setup guide
  4. Open PR against main with description of changes
  5. Wait for CI to pass; address review feedback

Code Style

  • Rust: cargo fmt (rustfmt) and cargo clippy (lints)
  • TypeScript: Prettier + ESLint (configured in ui/operator)
  • Commits: Signed-off-by line (DCO) not required for now; may add later

Testing

  • Unit tests: cargo test (Rust), npm test (UI)
  • Integration: ./scripts/smoke.sh after docker compose up
  • Manual: Follow README test profiles (Sanity, Blackout, Loss)

Documentation

  • Update ARCHITECTURE.md for component changes
  • Update README.md for user-facing features
  • Add comments for mTLS/SPIFFE hook points

CLA / DCO

None for now. Contributors retain copyright; code is Apache-2.0 licensed.

Code of Conduct

See CODE_OF_CONDUCT.md.
⚡