Contributing

Applies to the nori repository at 0.6.

Welcome. nori is MIT licensed, and changes come as pull requests on GitHub.

Before you start

• Read AGENTS.md: it is the working agreement for people and agents alike, with the commands, the boundaries between the core and the clients, the code rules and the commit format.
• Build and test with Building and Testing. Run cargo with four jobs at most.
• A bug fix starts with a test that fails on the bug.

Commits

One line, conventional, as AGENTS.md describes. The changelog is made from feat, fix and perf subjects, so write those for the people who use nori.

The docs

• Published docs live in docs/site/, as Markdown with title, description and an optional sidebar.order in the frontmatter. They change with the code, in the same commit when they can.
• The website copies them at build time; edit them here, never on the website.
• Internal notes (docs/features.md, docs/research/, docs/motion.md, docs/player-colour-band.md) stay unpublished.
• Every page says which versions and clients it applies to, and states only what the code does.

Security

Report a vulnerability privately, as SECURITY.md says, not in a public issue.