Raphaël Forment
5a59937cc7
All checks were successful
Deploy Website / deploy (push) Has been skipped
40 lines
1.2 KiB
Markdown
40 lines
1.2 KiB
Markdown
# Contributing to Cagire
|
|
|
|
Contributions are welcome. There are many ways to contribute beyond code:
|
|
|
|
- **Bug reports**: Open an issue describing the problem and steps to reproduce.
|
|
- **Feature requests**: Suggest new features or improvements.
|
|
- **Documentation**: Fix typos, clarify explanations, or add examples.
|
|
- **Testing**: Try Cagire on different platforms, report issues.
|
|
|
|
## Prerequisites
|
|
|
|
- **Rust** (stable toolchain) - [rustup.rs](https://rustup.rs/)
|
|
- **System libraries** - See [BUILDING.md](BUILDING.md) for platform-specific packages (cmake, ALSA, etc.)
|
|
|
|
## Quick start
|
|
|
|
```sh
|
|
cargo build
|
|
cargo clippy
|
|
cargo run
|
|
```
|
|
|
|
## Code contributions
|
|
|
|
1. Fork the repository
|
|
2. Create a branch for your changes
|
|
3. Make your changes
|
|
4. Run `cargo clippy` and fix any warnings
|
|
5. Submit a pull request with a clear description
|
|
|
|
Explain the reasoning behind your changes. Document what problem you're solving and how your solution works.
|
|
|
|
## Code of conduct
|
|
|
|
This project follows the [Contributor Covenant 2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct/). By participating, you agree to uphold its standards.
|
|
|
|
## License
|
|
|
|
By contributing, you agree that your contributions will be licensed under AGPLv3.
|