Thank you for your interest in contributing! We welcome bug reports, feature suggestions, documentation improvements, and code contributions.
- Fork the Repository and clone your fork locally:
git clone https://github.com/<your-username>/<repo-name>.git cd <repo-name>
- Create a Feature Branch:
git checkout -b feat/your-feature-name # or git checkout -b fix/your-bugfix-name - Set Up & Test Locally:
- For Rust:
cargo check && cargo test && cargo clippy - For Node / TypeScript:
npm install && npm run lint && npm test - For Python:
pytest && ruff check .
- For Rust:
- Commit Your Changes: Follow Conventional Commits:
feat: add post-quantum signature verificationfix: resolve race condition in websocket reconnectiondocs: update quickstart instructions in READMErefactor: simplify token parsing logic
- Push and Open a Pull Request:
Fill out the Pull Request template thoroughly.
git push origin feat/your-feature-name
- Minimal & Clean: No dead code, unnecessary dependencies, or unrequested boilerplate.
- Type Safety: Ensure strict typing across TypeScript, Rust, or Python type hints.
- Formatting:
- Rust:
cargo fmt - JS/TS:
prettier/eslint - Python:
ruff formatorblack
- Rust:
- Tests: Add unit/integration tests for any non-trivial logic changes.
By contributing, you agree that your contributions will be licensed under the project's open-source license.