Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
20 lines (15 loc) · 895 Bytes

CONTRIBUTING.md

File metadata and controls

20 lines (15 loc) · 895 Bytes
Raw

Contributing

Contributions should include specification-section provenance, known binary vectors, round-trip tests, and malformed-input tests. Run dotnet test --configuration Release before opening a pull request. Do not submit IEEE specification text or non-public operational packet captures.

Parser and framing changes should also run the bounded fuzz corpus:

dotnet run --project tests/OpenDisNet.Fuzz -c Release -- --smoke

See docs/fuzzing.md before starting a sustained SharpFuzz campaign or contributing a minimized crash regression.

The 1.x public API follows semantic versioning. Additive API changes must update src/OpenDisNet/PublicAPI.Unshipped.txt, include tests, and describe the consumer benefit in the changelog. Removals or incompatible signature changes require explicit breaking-change review and belong in the next major release.