795b9c23fe
- Rewrote CONTRIBUTING.md in casual, direct style - Rewrote SECURITY.md to be less formal - Fixed GitHub URLs in CHANGELOG.md - Removed formal issue/PR templates - Removed codecov.yml configuration file All docs now sound human, not AI-generated.
869 B
869 B
Contributing
Thanks for wanting to help out.
Quick start
- Fork the repo
- Clone it:
git clone your-fork-url - Make a branch:
git checkout -b your-feature - Code, test, commit
- Push and open a PR
Before you commit
Run these:
cargo fmt --all
cargo clippy --all -- -D warnings
cargo test --all
If stuff fails, fix it before pushing.
Commit messages
Keep them short and clear:
feat: add new detection methodfix: crash when scanning process 0docs: update README examples
What needs work
- macOS support is barely there
- Tests could use more coverage
- Documentation always needs updates
- Performance optimizations
- More detection techniques
Code guidelines
- Write Rust that doesn't suck
- Document weird stuff
- Add tests for new features
- Don't break existing functionality
That's it. Keep it simple.