Skip to content

Commit 236dcb9

Browse files
authored
fix/improve rdg contributing howto (rust-lang#2056)
1 parent 9cbb920 commit 236dcb9

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

src/contributing.md

+10-9
Original file line numberDiff line numberDiff line change
@@ -316,9 +316,8 @@ There are issues for beginners and advanced compiler devs alike!
316316

317317
Just a few things to keep in mind:
318318

319-
- Please try to avoid overly long lines and use semantic line breaks (so break the line after a sentence).
320-
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.
321-
There is currently nothing stopping anyone from creating overly long lines, just do your best to avoid them.
319+
- Please try to avoid overly long lines and use semantic line breaks (where you break the line after each sentence).
320+
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.
322321

323322
- When contributing text to the guide, please contextualize the information with some time period
324323
and/or a reason so that the reader knows how much to trust or mistrust the information.
@@ -336,35 +335,37 @@ Just a few things to keep in mind:
336335
- january 2021
337336

338337
There is a CI action (in `~/.github/workflows/date-check.yml`)
339-
that generates a monthly issue with any of these that are over 6 months old.
338+
that generates a monthly showing those that are over 6 months old
339+
([example](https://github.com/rust-lang/rustc-dev-guide/issues/2052)).
340340

341341
For the action to pick the date,
342342
add a special annotation before specifying the date:
343343

344344
```md
345-
<!-- date-check --> Jan 2023
345+
<!-- date-check --> Sep 2024
346346
```
347347

348348
Example:
349349

350350
```md
351-
As of <!-- date-check --> Jan 2023, the foo did the bar.
351+
As of <!-- date-check --> Sep 2024, the foo did the bar.
352352
```
353353

354354
For cases where the date should not be part of the visible rendered output,
355355
use the following instead:
356356

357357
```md
358-
<!-- date-check: Jan 2023 -->
358+
<!-- date-check: Sep 2024 -->
359359
```
360360

361361
- A link to a relevant WG, tracking issue, `rustc` rustdoc page, or similar, that may provide
362362
further explanation for the change process or a way to verify that the information is not
363363
outdated.
364364

365365
- If a text grows rather long (more than a few page scrolls) or complicated (more than four
366-
subsections) it might benefit from having a Table of Contents at the beginning, which you can
367-
auto-generate by including the `<!-- toc -->` marker.
366+
subsections),
367+
it might benefit from having a Table of Contents at the beginning,
368+
which you can auto-generate by including the `<!-- toc -->` marker at the top.
368369

369370
## Issue triage
370371

0 commit comments

Comments
 (0)