diff --git a/text/1589-rustc-bug-fix-procedure.md b/text/1589-rustc-bug-fix-procedure.md index acdc481015e..80521ce4b41 100644 --- a/text/1589-rustc-bug-fix-procedure.md +++ b/text/1589-rustc-bug-fix-procedure.md @@ -104,23 +104,27 @@ this page is describe why this change was made and how you can fix code that is affected by it. It also provides a place to ask questions or register a complaint if you feel the change should not be made. For more information on the policy around future-compatibility warnings, -see our [breaking change policy guidelines][guidelines]. +see our [breaking change policy guidelines][RFC 1589]. -[guidelines]: LINK_TO_THIS_RFC +[RFC 1589]: https://github.com/rust-lang/rfcs/blob/master/text/1589-rustc-bug-fix-procedure.md -#### What is the warning for? +#### What is this lint about -*Describe the conditions that trigger the warning and how they can be -fixed. Also explain why the change was made.** +*Describe here what kinds of Rust code will cause the lint to trigger.* -#### When will this warning become a hard error? - -At the beginning of each 6-week release cycle, the Rust compiler team -will review the set of outstanding future compatibility warnings and -nominate some of them for **Final Comment Period**. Toward the end of -the cycle, we will review any comments and make a final determination -whether to convert the warning into a hard error or remove it -entirely. +*Motivational text or historical information is also of use, but the +most important thing is to explain what kind of code the lint is +detecting.* + +#### How to fix this warning/error + +*Explain here what the developer needs to do to address the warning.* + +#### Current status + +- [ ] PR ? introduces the `YOUR_LINT_NAME_HERE` lint as warn-by-default +- [ ] PR ? makes the `YOUR_LINT_NAME_HERE` lint deny-by-default +- [ ] PR ? makes the `YOUR_LINT_NAE_HERE` lint a hard error --------------------------------------------------------------------------- @@ -278,6 +282,10 @@ policy and not making any sort of breaking change at all: N/A +# Amendments + +* Amended template to match current practice. + [RFC 1122]: https://github.com/rust-lang/rfcs/blob/master/text/1122-language-semver.md