@@ -405,27 +405,38 @@ Just a few things to keep in mind:
405
405
406
406
- Please limit line length to 100 characters. This is enforced by CI, and you can run the checks
407
407
locally with ` ci/check_line_lengths.sh ` .
408
+
408
409
- When contributing text to the guide, please contextualize the information with some time period
409
410
and/or a reason so that the reader knows how much to trust or mistrust the information.
410
411
Aim to provide a reasonable amount of context, possibly including but not limited to:
412
+
411
413
- A reason for why the data may be out of date other than "change", as change is a constant across
412
414
the project.
415
+
413
416
- The date the comment was added, e.g. instead of writing _ "Currently, ..."_
414
417
or _ "As of now, ..."_ , consider writing
415
418
_ "As of January 2021, ..."_ .
416
419
Try to format the date as ` <MONTH> <YEAR> ` to ease search.
420
+
417
421
- Additionally, include a machine-readable comment of the form `<!-- date:
418
422
2021-01 -->` (if the current month is January 2021). We have an automated
419
423
tool that uses these (in ` ci/date-check ` ).
424
+
425
+ So, for the month of January 2021, the comment would look like: `As of <!--
426
+ date: 2021-01 --> January 2021` . Make sure to put the comment *between* ` as of`
427
+ and ` January 2021 ` ; see [ PR #1066 ] [ rdg#1066 ] for the rationale.
428
+
420
429
- A link to a relevant WG, tracking issue, ` rustc ` rustdoc page, or similar, that may provide
421
430
further explanation for the change process or a way to verify that the information is not
422
431
outdated.
432
+
423
433
- If a text grows rather long (more than a few page scrolls) or complicated (more than four
424
434
subsections) it might benefit from having a Table of Contents at the beginning, which you can
425
435
auto-generate by including the ` <!-- toc --> ` marker.
426
436
427
437
[ rdg ] : https://rustc-dev-guide.rust-lang.org/
428
438
[ rdgrepo ] : https://github.com/rust-lang/rustc-dev-guide
439
+ [ rdg#1066 ] : https://github.com/rust-lang/rustc-dev-guide/pull/1066
429
440
430
441
## Issue Triage
431
442
0 commit comments