From 89d7cd35b643adac24f7d613e872f5768f3a8eb1 Mon Sep 17 00:00:00 2001 From: Tshepang Mbambo Date: Thu, 5 Sep 2024 12:07:52 +0200 Subject: [PATCH] fix/improve rdg contributing howto --- src/contributing.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/src/contributing.md b/src/contributing.md index be369a872..4ff2e4059 100644 --- a/src/contributing.md +++ b/src/contributing.md @@ -316,9 +316,8 @@ There are issues for beginners and advanced compiler devs alike! Just a few things to keep in mind: -- Please try to avoid overly long lines and use semantic line breaks (so break the line after a sentence). - There is no strict limit on line lengths, let the sentence or part of the sentence flow to its proper end on the same line. - There is currently nothing stopping anyone from creating overly long lines, just do your best to avoid them. +- Please try to avoid overly long lines and use semantic line breaks (where you break the line after each sentence). + There is no strict limit on line lengths; let the sentence or part of the sentence flow to its proper end on the same line. - When contributing text to the guide, please contextualize the information with some time period and/or a reason so that the reader knows how much to trust or mistrust the information. @@ -336,26 +335,27 @@ Just a few things to keep in mind: - january 2021 There is a CI action (in `~/.github/workflows/date-check.yml`) - that generates a monthly issue with any of these that are over 6 months old. + that generates a monthly showing those that are over 6 months old + ([example](https://github.com/rust-lang/rustc-dev-guide/issues/2052)). For the action to pick the date, add a special annotation before specifying the date: ```md - Jan 2023 + Sep 2024 ``` Example: ```md - As of Jan 2023, the foo did the bar. + As of Sep 2024, the foo did the bar. ``` For cases where the date should not be part of the visible rendered output, use the following instead: ```md - + ``` - A link to a relevant WG, tracking issue, `rustc` rustdoc page, or similar, that may provide @@ -363,8 +363,9 @@ Just a few things to keep in mind: outdated. - If a text grows rather long (more than a few page scrolls) or complicated (more than four - subsections) it might benefit from having a Table of Contents at the beginning, which you can - auto-generate by including the `` marker. + subsections), + it might benefit from having a Table of Contents at the beginning, + which you can auto-generate by including the `` marker at the top. ## Issue triage