Contributing
Read AGENTS.md first: it holds the layout, rules and the checks CI runs.
Adding a helper
Section titled “Adding a helper”- Pick the module (
src/<module>/); check the standard library does not already cover it. - Create
src/<module>/<name>.rswith the license header, rustdoc (with a runnable# Examplesblock) and the implementation, then its sibling files:<name>.test.rs(unit tests),<name>.spec.rs(proptest) and optionally<name>.bench.rs. See the layout in AGENTS.md. - Re-export it from
src/<module>/mod.rs. - If there is a benchmark, add it to
benches/<module>.rsand to itscriterion_group!. - Run every command listed under “Key commands” in AGENTS.md. Coverage must stay at 100%.
Adding a module
Section titled “Adding a module”Add a Cargo feature, gate pub mod <module> on it in src/lib.rs, add the module’s
scope to scopes.json, list it in llms.txt, and add a bench with required-features.
Commits
Section titled “Commits”<type>(<scope>): <emoji> <description> — see the
org rules; scopes come from scopes.json.
By contributing, you agree that your contributions are licensed under LGPL-3.0-or-later.
