Contributing
Mediaway takes contributions — code, design feedback, and bug reports.
- Human contributor guide:
CONTRIBUTING.md - Getting-started, docs map, PR process:
docs/contributing/ - PR author checklist (doc sync, quality gates):
docs/contributing/pull-requests.md - Adding a new crate, per-language example, or reference page: Extending the Book
- Bug/crash/docs issues use the issue tracker; feature ideas start as
GitHub Discussions —
see
docs/contributing/issues.mdfor the split.
Dev setup
# Toolchain (rust-toolchain.toml pins stable)
rustup show
# Hooks
cargo install lefthook cargo-deny
lefthook install
# Optional — some suites use these as test/dev oracles or accelerate nextest
cargo install cargo-nextest gitleaks
cargo nextest run --workspace # preferred when installed
cargo test --workspace # fallback
If you’re bringing an AI coding assistant
Start with
docs/contributing/for-agents.md,
then the project’s AGENTS.md (single source of truth for repo conventions
— license/safety rules, architecture rules, commit format, and more).