Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
14 lines (11 loc) · 803 Bytes

CONTRIBUTING.md

File metadata and controls

14 lines (11 loc) · 803 Bytes
Raw

Contributing

  1. Read docs/CODING_STANDARDS.md and docs/DESIGN.md.
  2. After code changes:
./scripts/dev.sh format
./scripts/dev.sh sanitize
  1. New API needs tests. Overwrite-on-full, empty/full, move-only types, and allocators are required edges.
  2. Do not add third-party test frameworks or runtime dependencies. Benches may optionally find Boost to compare against boost::circular_buffer; that does not make Boost a test or library dependency.
  3. After hot-path changes, follow docs/BENCH.md: one idea, full Boost suite, keep-or-revert, then a remote release-bench if the change is GCC-shaped. Apple Clang does not predict Ubuntu GCC.
  4. Comments, commit messages, GitHub issues, and PR titles/bodies are English.