Commit Graph

36 Commits

Author SHA1 Message Date
Felix S Klock II 2c5b2e3d7c
Merge pull request #2432 from joshtriplett/think-about-maintenance
0000-template.md: Encourage discussion of maintenance
2022-11-01 10:44:25 -04:00
Josh Triplett 71e82bfb50 Change "how will this" to just "will this"
"how will this" comes across as though *every* RFC is about making code
easier to maintain. Some RFCs may just be maintenance-neutral.
2022-11-01 15:34:25 +01:00
Josh Triplett 2ea3731af1 0000-template.md: Encourage discussion of maintenance
Add some points to encourage RFCs to discuss how a proposal impacts the
ease of reading, understanding, and maintaining Rust code, not just the
ease of writing it.
2022-11-01 15:34:11 +01:00
Marcelina Kościelnicka 9b255a30b5 Fix fallout from #3119 merge.
It appears that some of the changes that were meant to go to RFC 3119
ended up in the RFC template instead.
2021-09-23 18:25:07 +02:00
Manish Goregaokar 7935e9b740 Fix renamed files 2021-09-11 12:09:42 -07:00
Manish Goregaokar 322a80fc19 RFC 3119 is Rust-lang crate ownership policy 2021-09-11 11:39:45 -07:00
JonDavid Ebadirad 83e82a1369 template-typo 2020-10-26 11:12:27 -07:00
Mazdak Farrokhzad ab09d2fbe3
Simplify template for FCP-complete merging steps
I have to manually copy this from an old merged RFC every time; this change saves me some time.
2019-02-26 23:42:09 +01:00
Mazdak Farrokhzad b7545d66a4 rfc, future-work: implement in the template. 2018-10-26 21:04:34 +02:00
Mazdak Farrokhzad cc2faf7c4d
Fix link in RFC template and stuff 2018-07-17 02:36:36 +02:00
culshoefer 9043784aaa Change exists to exist in template.md#prior-art 2018-03-26 12:11:15 -04:00
Mazdak Farrokhzad a488ca0263
Merge pull request #2333 from Centril/rfc/prior-art
Meta-RFC: Prior art
2018-02-27 21:06:06 +01:00
Mazdak Farrokhzad e225f1be3b rfc, prior-art: communicate intentional divergence per @wycats's comments 2018-02-15 06:28:46 +01:00
Mazdak Farrokhzad 1118f8872d rfc, prior-art: fix grammar, thanks @wycats 2018-02-15 06:18:52 +01:00
Mazdak Farrokhzad f08f881847 rfc, prior-art: self-execute in template 2018-02-13 00:03:30 +01:00
Nelson Chen 0bb94aa049
Fix small typo in template. 2018-01-04 14:38:47 -07:00
Nikhil Benesch ea6812f98e Use consistent title-casing in RFC template 2017-09-18 16:28:45 -04:00
Josh Triplett e2cc1e5c26 0000-template.md: Fix typo: s/tha/that/ 2017-08-05 13:34:43 -07:00
Carol (Nichols || Goulding) 117f9b96f8 Address different kinds of unresolved questions 2017-07-19 16:25:48 -04:00
Carol (Nichols || Goulding) 4a3f5c5570 Adjust Alternatives section to be Rationale and Alternatives
As discussed in the core team meeting
2017-07-19 16:11:14 -04:00
Carol (Nichols || Goulding) 03c1456e4c Add a line about existing vs new Rust programmers 2017-07-12 19:52:34 -04:00
Carol (Nichols || Goulding) f026f04f77 Switch to "Guide-level" and "Reference-level" explanations
As proposed by aturon <3

These sections replace the "Detailed design" and "How do we teach this?"
sections, and switch their order.

Instead of describing how we would teach a change as a result of a
proposal, the "Guide-level explanation" section will actually attempt to
teach the reader the feature, in a lightweight way.

The guide-level explanation appears first in order to help RFC writers
keep Rust users in the front of their minds, and in order to help RFC
readers understand how an RFC will affect them sooner in the RFC. This
will hopefully make the RFC process more accessible to people who are
Rust users but not compiler or language design experts.
2017-07-12 19:50:25 -04:00
Carol (Nichols || Goulding) 49d16567d1 Add some more prompts to the "How do we teach this?" section 2017-06-26 19:21:05 -04:00
Chris Krycho 75bbe75358 Wrap sentences to newlines in "How We Teach This" 2016-12-07 13:00:31 -05:00
Chris Krycho 59e35882ef Add 'How We Teach This' to template, per RFC 1636. 2016-12-06 21:47:14 -05:00
Alex Crichton 43efcc6ee6 Add back the template 2016-04-21 09:22:22 -07:00
Brian Anderson fb5c86791c Stabilize -C overflow-checks 2016-03-09 22:04:49 +00:00
Felix S. Klock II 67c2049be5 I always find myself adding these anchors (or some variant thereof)
while I'm drafting an RFC.

Lets put them into the template so that people will get them by
default.

(Hopefully we don't need an RFC to decide whether to change the RFC
template in this manner.)
2015-10-20 16:54:22 +02:00
Brian Anderson 7007f863d1 Add feature name header to RFC template 2015-02-05 14:24:09 -08:00
Chris Morgan 1d7d9f908f Improve the issue reference format in headers.
Fixes #62. Of the formats proposed there, I went with option (e.c).
2014-07-30 21:05:33 +10:00
Ben Striegel d13e5a1266 Move "Drawbacks" section after "Detailed design"
Having "Drawbacks" earlier in the document than "Detailed design" makes
it awkward to discuss drawbacks that reference details of the design.
This encourages authors to either violate causality by referencing
details before they are introduced or to neglect the "Drawbacks" section
entirely and just sprinkle the discussion of drawbacks throught
"Detailed design".
2014-05-19 06:39:51 -04:00
Simon Sapin ee8872d233 [Meta] Add a "Drawbacks" section to the template.
(The name could be something else.)

Listing known disadvantages from the start will hopefully facilitate
discussion.
2014-04-04 23:35:42 +01:00
Brian Anderson 350ceba333 Fix typo in template 2014-03-25 15:13:49 -07:00
Brian Anderson 1289937943 Change date format to YYYY-MM-DD 2014-03-13 14:34:32 -07:00
Brian Anderson 3aa5393854 Add a little bit of metadata to template 2014-03-12 13:52:06 -07:00
Brian Anderson 14ca6f6550 Add a template RFC 2014-03-10 14:49:32 -07:00