Skip to content

Commit 18d6c55

Browse files
committed
Mention our policy on typofixes for internal docs and tests
1 parent 10afc65 commit 18d6c55

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

src/how-to-start-contributing.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,15 +110,23 @@ There are various ways in which you can contribute to Rust projects:
110110
you can help improve our GitHub CI workflows, automation Python scripts or contribute to web
111111
frontends with HTML/CSS/JS (e.g. [Rustdoc][rustdoc-ui] or [Benchmark suite website][rustc-perf-ui]).
112112
Play to your strengths!
113+
113114
- Improving documentation is possibly one of the easiest starting points for contributions.
114115
Did you find a typo, something that was unclear, or do you miss some useful information on this
115116
page, elsewhere in the Forge or in some other Rust (user-facing) documentation? Great, then send
116117
a pull request and you'll become a contributor! :)
118+
119+
Please notice that at this time **we don't accept typography/spellcheck fixes to internal documentation or in our
120+
testsuite** (reason: they could inadvertedly cause code regressions)
121+
117122
- Improving tests is also very valuable, as there is never enough of them. This can include also
118123
documenting existing tests or writing tests for already fixed issues that lack a proper test.
124+
119125
- You can also help with improving issue trackers of our repositories, by helping with [triaging issues][issue-triage]
120126
or by reproducing old issues to find out whether they are still valid or not.
127+
121128
- Or, if you like programming language discussions, you could participate in our [RFC process](https://github.com/rust-lang/rfcs).
129+
122130
- You can also answer questions to help other Rust users, in the _Get Help!_ channels on the [Rust Discord
123131
server][rust-discord], on [users.rust-lang.org][users] (URLO), or on [StackOverflow][so].
124132

0 commit comments

Comments
 (0)