Possible new sections or chapters
Open
Nobody has claimed this yet.
C-enhancement
E-hard
E-medium
help wanted
- Dominant language
- CSS
- Stars
- 2.3k
- Forks
- 325
- PR merge metrics
- No merged PRs in 30d
Description
Ideas for topics that would be useful to include in the Nomicon as new chapters or sections:
- miri
- unsafe working group / code guidelines
- Unions
- const and undefined behaviour
- ASAN, valgrind, etc
- Use in real world tips (documentation, commenting, macros, tools (cargo-gieger), CI)
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the Nomicon's existing chapter and section structure, then assess the listed topics: Miri, unsafe working group guidelines, unions, const and undefined behavior, ASAN, Valgrind, and real-world usage tips. Done would mean agreeing on scope and adding the selected topics as new chapters or sections.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100