# Contributing to netspeed-cli
Thank you for your interest in contributing to netspeed-cli! All contributions are welcome.
## Getting Started
### Prerequisites
- Rust 1.85 or later
- `cargo` package manager
### Setup
```bash
git clone https://github.com/mapleDevJS/netspeed-cli.git
cd netspeed-cli
cargo build
```
### Running Tests
```bash
cargo test
```
### Code Style
This project follows standard Rust formatting with clippy pedantic mode enabled:
```bash
cargo fmt # Format code
cargo clippy # Run linter
cargo clippy -- -D warnings # Fail on any warning
```
All CI checks must pass before a PR can be merged:
- `cargo test` on Ubuntu and macOS
- `cargo fmt -- --check`
- `cargo clippy -- -D warnings`
- `cargo audit` (security scan)
- MSRV verification with Rust 1.85
## Development Workflow
1. **Fork** the repository
2. **Create a branch** from `develop` (or `main` for hotfixes)
3. **Make your changes** with tests
4. **Run verification**: `cargo fmt && cargo clippy -- -D warnings && cargo test`
5. **Submit a PR** against `develop` (or `main` for hotfixes)
### Branch Strategy
- `main` — stable releases
- `develop` — integration branch for upcoming features
- Feature branches — `feature/your-feature-name`
- Hotfix branches — `hotfix/issue-description`
## What to Contribute
### Bug Fixes
If you find a bug, please:
1. Check existing issues to avoid duplicates
2. Open an issue if none exists
3. Submit a PR with a test that reproduces the bug and the fix
### New Features
For new features:
1. Open an issue first to discuss the approach
2. Wait for maintainer approval
3. Implement with tests and documentation
4. Submit a PR
### Documentation
Documentation improvements are always welcome:
- README clarifications
- Code comments
- Module-level doc comments (use `///` and `//!`)
- Examples and usage guides
## Testing Guidelines
- Write unit tests for pure functions
- Write integration tests for CLI behavior
- Use `wiremock` for HTTP mocking in network tests
- Tests should be fast and deterministic
- Avoid tests that require real network access
### Test Locations
- `src/*/mod.rs` — inline unit tests in `#[cfg(test)]` modules
- `tests/integration_test.rs` — CLI integration tests
- `tests/mock_network_test.rs` — HTTP mocking tests
## Code Conventions
- Follow [SOLID](https://en.wikipedia.org/wiki/SOLID) principles
- Use `#[must_use]` on pure functions
- Add `# Errors` section to `///` docs for `Result`-returning functions
- Keep modules focused on a single concern
- No dead code — remove unused functions and dependencies
- Error types go in `error.rs`, data types in `types.rs`
## Commit Messages
Follow [Conventional Commits](https://www.conventionalcommits.org/) format:
```
feat: add peak speed detection
fix: resolve XML parsing error on some servers
docs: update README installation instructions
test: add config file loading tests
ci: add cargo-audit job
```
## Questions?
If you have questions, feel free to:
- Open a [Discussion](https://github.com/mapleDevJS/netspeed-cli/discussions)
- Ask in an existing issue
## License
By contributing, you agree that your contributions will be licensed under the MIT License.