Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
41 lines (29 loc) · 1.22 KB

CONTRIBUTING.md

File metadata and controls

41 lines (29 loc) · 1.22 KB

Contributing to NetVeil

We welcome contributions from the security research community.

Getting Started

  1. Fork the repository
  2. Create a feature branch from main
  3. Make your changes
  4. Run cargo test and cargo clippy
  5. Open a pull request

What We're Looking For

  • New transport implementations
  • Improvements to existing obfuscation strategies
  • Traffic analysis test cases that break current transports
  • Performance optimizations
  • Documentation improvements

Code Standards

  • All code must pass cargo clippy -- -D warnings
  • All code must be formatted with cargo fmt
  • New transports must implement the Transport trait
  • Cryptographic code should use established crates, not custom implementations
  • Include benchmarks for performance-sensitive code

Testing

We particularly value adversarial test cases. If you can build a classifier that distinguishes NetVeil traffic from the target profile, that's a valuable contribution — it tells us where to improve.

cargo test                    # Unit tests
cargo test --test integration # Integration tests
cargo bench                   # Benchmarks

License

By contributing, you agree that your contributions will be licensed under the MIT License.