Contributions are welcome!
These docs are licensed under CC-BY-4.0.
If you would like to make significant changes or additions, please file an issue first to discuss.
Small PRs correcting spelling, grammar, or technical details are welcome. However, please avoid PRs which are small, subjective improvements. If there is something you'd like to generally improve, please open an issue and discuss it first. This is an opinionated guide, so not agreeing with something is not cause to change it.
All PRs will need review before merging. If you've been waiting more than a few days please ping @nrc on the PR for a review.
Please see the below sections on AI-assisted contributions and writing style before working on the guide.
Please behave and follow the Rust community code of conduct.
I don't care what tools you use, but I do care about the quality of the work. Whether or not you use an LLM, a spell-checker, or get your mum to help you, I expect you to take responsibility for your contributions. All contributions (PRs and issues) should be properly reviewed by the (human) author of the contribution. Sloppy work will be closed without proper review whether or not there was AI involved with the creation.
I would encourage you to write your own words. LLMs are currently much better at producing code than prose. Having an LLM review your work may be useful, but you should also review it yourself. I (@nrc) have only used AI for review (and evaluated those reviews point-by-point), never for writing prose or code in this project.
If AI was significantly involved in a PR or issue, it would be helpful for you to state that and describe how.
There is a CLAUDE.md and the primary intention for this is to aid with review. Do not understand the existence of CLAUDE.md to mean that any text is generated by AI or that using AI is encouraged.
This is very incomplete!
- The guide is written in American English in a semi-formal style.
- The intended audience is beginner or intermediate Rust programmers (but not absolute beginners).
- Writing should be concise and clear. Use the active voice and plural pronouns when referring to the author(s) or reader.
- Do use Oxford commas, e.g., 'foo, bar, and baz', not 'foo, bar and baz'.
- Capitalize and punctuate bulleted lists as if each bullet is a complete sentence.
- Keep examples small and targetted. They don't need to be a complete program, but should be correct Rust.