The Advanced Rebasing section has been mostly rewritten to include
both a major suggestion from jyn and a general rewrite. Additional
thanks to camelid for some suggestions!
The previous iteration of the page was often wordy and
occasionally unclear. This has been cleaned up in places.
Additionally, the TODO in the no-merge policy section has been
removed and addressed.
This section addresses the biggest issues that new contributors,
especially those with limited familiarity with git, are likely to
face. This is still a WIP.
Thanks to jyn for the recommended improvements!
A link to the relevant section of the contributing documentation makes it easier for contributors to locate the relevant information. (e.g. via an in-page search for "doc".)
This is particularly important currently as 85072e3303/CONTRIBUTING.md links directly to the (currently `rustc`-focused) "Getting Started" guide rather than the general Rust contribution content to which it used to point.
Immediately below the section on copyright notices being removed,
it is mentioned that a particular thing should be placed below the
notices. This seems confusing.
I was confused about what the different levels mean. This PR adds a paragraph that shortly explains the rationale behind different mir-opt-levels and links to the current proposal where there's some information about them.
Let me know if I wrote something unreasonable or incorrect.
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
* Improve instructions for adding a new test
- Add a section for library tests
- Expand section on rustdoc tests
* Address review comments
- Say what should be considered a library test
- Mention adding error numbers to doc tests
- Link to #ui section
- Line wrapping
* Fix incorrect link
It shouldn't have been a link in the first place.
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
