Skip to content

Commit ab6531d

Browse files
apirainoapiraino
authored
Mention our policy on typofixes for internal docs and tests (#926)
1 parent 57efdc9 commit ab6531d

File tree

1 file changed

+18
-9
lines changed

1 file changed

+18
-9
lines changed

‎src/how-to-start-contributing.md

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,27 +30,27 @@ expert time", but we do not feel that way. Contributors are important to us.
3030
## How to start contributing?
3131

3232
The Rust project is quite large and it can be difficult to know which parts of the project need
33-
help, or are a good starting place for beginners. Here is a (non-exhaustive) list of
33+
help, or are a good starting place for beginners. Here is a (non-exhaustive) list of
3434
`rust-lang` projects that could serve as starting places for you to contribute. Some of them
3535
have contributor guides and issues that are marked as needing help or being good first issues.
3636

3737
| Project | Contribution guide | Good first issues | Description |
3838
|------------------------------------|-------------------------------------------------|---------------------------------------|-----------------------------------------|
3939
| [Compiler][rustc-repo] | [rustc-dev-guide][rustc-guide] | [Good first issues][rustc-issues] | Rust compiler and associated tooling |
4040
| [Standard library][std-repo] | [std-dev-guide][std-guide] | | Rust standard library |
41-
| [Rustdoc][rustdoc-repo] | [Rustdoc overview][rustdoc-guide] | | Rust documentation generator |
42-
| [Cargo][cargo-repo] | [Cargo Contributor Guide][cargo-guide] | [Good first issues][cargo-issues] | Rust package manager and build system |
41+
| [Rustdoc][rustdoc-repo] | [Rustdoc overview][rustdoc-guide] | | Rust documentation generator |
42+
| [Cargo][cargo-repo] | [Cargo Contributor Guide][cargo-guide] | [Good first issues][cargo-issues] | Rust package manager and build system |
4343
| [Clippy][clippy-repo] | [Clippy Contributor Guide][clippy-guide] | [Good first issues][clippy-issues] | Rust linter |
4444
| [Rustfmt][rustfmt-repo] | [Rustfmt Contributing Guide][rustfmt-guide] | [Good first issues][rustfmt-issues] | Rust formatter |
4545
| [Rust analyzer][analyzer-repo] | [Contributing Quick Start][analyzer-guide] | [Good first issues][analyzer-issues] | Rust compiler frontend and LSP for IDEs |
4646
| [Miri][miri-repo] | [Miri Contribution Guide][miri-guide] | [Good first issues][miri-issues] | Rust interpreter and UB detector |
4747
| [Rustup][rustup-repo] | [Rustup Developer Guide][rustup-guide] | [Help wanted][rustup-issues] | Rust toolchain installer |
48-
| [crates.io][crates-io-repo] | [crates.io Contribution guide][crates-io-guide] | [Issue tracker][crates-io-issues] | Rust package registry |
49-
| [Bors][bors-repo] | [bors Development guide][bors-guide] | [Help wanted][bors-issues] | Rust CI merge bot |
50-
| [rustc-perf][rustc-perf-repo] | | [Help wanted][rustc-perf-issues] | Rust compiler benchmark suite |
51-
| [Triagebot][triagebot-repo] | | [Good first issues][triagebot-issues] | Rust automation bot |
52-
| [Rust playground][playground-repo] | | [Help wanted][playground-issues] | Rust online playground |
53-
| [Rustlings][rustlings-repo] | [Rustlings Contribution Guide][rustlings-guide] | [Issue tracker][rustlings-issues] | Rust exercises |
48+
| [crates.io][crates-io-repo] | [crates.io Contribution guide][crates-io-guide] | [Issue tracker][crates-io-issues] | Rust package registry |
49+
| [Bors][bors-repo] | [bors Development guide][bors-guide] | [Help wanted][bors-issues] | Rust CI merge bot |
50+
| [rustc-perf][rustc-perf-repo] | | [Help wanted][rustc-perf-issues] | Rust compiler benchmark suite |
51+
| [Triagebot][triagebot-repo] | | [Good first issues][triagebot-issues] | Rust automation bot |
52+
| [Rust playground][playground-repo] | | [Help wanted][playground-issues] | Rust online playground |
53+
| [Rustlings][rustlings-repo] | [Rustlings Contribution Guide][rustlings-guide] | [Issue tracker][rustlings-issues] | Rust exercises |
5454
| [MdBook][mdbook-repo] | [MdBook Contribution Guide][mdbook-guide] | [Good first issues][mdbook-issues] | Book generator written in Rust |
5555

5656
[rustc-repo]: https://github.com/rust-lang/rust
@@ -110,15 +110,24 @@ 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
120+
documentation** (usually not worth the churn or the review time) **or in our testsuite** (they
121+
could inadvertently cause code regressions)
122+
117123
- Improving tests is also very valuable, as there is never enough of them. This can include also
118124
documenting existing tests or writing tests for already fixed issues that lack a proper test.
125+
119126
- You can also help with improving issue trackers of our repositories, by helping with [triaging issues][issue-triage]
120127
or by reproducing old issues to find out whether they are still valid or not.
128+
121129
- Or, if you like programming language discussions, you could participate in our [RFC process](https://github.com/rust-lang/rfcs).
130+
122131
- You can also answer questions to help other Rust users, in the _Get Help!_ channels on the [Rust Discord
123132
server][rust-discord], on [users.rust-lang.org][users] (URLO), or on [StackOverflow][so].
124133

0 commit comments

Comments
 (0)