41 lines
835 B
Markdown
41 lines
835 B
Markdown
# Contributing to Ghost
|
|
|
|
Thank you for your interest in contributing to Ghost!
|
|
|
|
## Getting Started
|
|
|
|
1. Fork the repository
|
|
2. Clone your fork
|
|
3. Create a branch: `git checkout -b feature/your-feature`
|
|
4. Make changes and test: `cargo test --all`
|
|
5. Format code: `cargo fmt --all`
|
|
6. Check lints: `cargo clippy --all`
|
|
7. Commit: `git commit -m "feat: description"`
|
|
8. Push and open a Pull Request
|
|
|
|
## Code Style
|
|
|
|
- Follow Rust conventions
|
|
- Use rustfmt and clippy
|
|
- Write clear, documented code
|
|
- Add tests for new features
|
|
|
|
## Commit Messages
|
|
|
|
Use conventional commits:
|
|
- `feat:` New feature
|
|
- `fix:` Bug fix
|
|
- `docs:` Documentation
|
|
- `refactor:` Code refactoring
|
|
- `test:` Tests
|
|
|
|
## Areas for Contribution
|
|
|
|
- macOS support
|
|
- Threat intelligence feeds
|
|
- eBPF implementation
|
|
- Test coverage
|
|
- Documentation
|
|
|
|
Thank you for contributing!
|