Contributing
July 17, 2026 · View on GitHub
We welcome contributions! Please follow these steps to get started:
- Fork the repository
- Create a feature branch (e.g.,
git checkout -b feature/my-feature) - Make your changes
- Run code quality checks:
- Check formatting with
cargo fmt --all -- --check - Run tests with
cargo test --workspace - Lint with
cargo clippy --workspace --all-targets --all-features -- -D warnings
- Check formatting with
- Commit your changes with clear, descriptive commit messages.
- Open a Pull Request against the
mainbranch.
Before Submitting a Pull Request
- Verify that the project builds and runs on macOS (primary platform).
- Treat Linux and Windows behavior as experimental and report what was tested.
- Ensure any new code includes appropriate documentation and tests.
- Update the changelog if your changes are user‑visible.
- Follow the existing code style and conventions.
Code of Conduct
We expect all contributors to adhere to the repository's Contributor Covenant Code of Conduct, which is based on version 2.0.
Thank you for helping make SilentKeys better!