@@ -70,20 +70,67 @@ Just pinging someone without providing any context can be a bit annoying and
70
70
just create noise, so we ask that you be mindful of the fact that the
71
71
` t-compiler ` folks get a lot of pings in a day.
72
72
73
- ## Cloning and Building
73
+ ## What should I work on?
74
74
75
- See [ "How to build and run the compiler"] ( ./building//how-to-build-and-run.md ) .
75
+ The Rust project is quite large and it can be difficult to know which parts of the project need
76
+ help, or are a good starting place for beginners. Here are some suggested starting places.
77
+
78
+ ### Easy or mentored issues
79
+
80
+ If you're looking for somewhere to start, check out the following [ issue
81
+ search] [ help-wanted-search ] . See the [ Triage] for an explanation of these labels. You can also try
82
+ filtering the search to areas you're interested in. For example:
83
+
84
+ - ` repo:rust-lang/rust-clippy ` will only show clippy issues
85
+ - ` label:T-compiler ` will only show issues related to the compiler
86
+ - ` label:A-diagnostics ` will only show diagnostic issues
87
+
88
+ Not all important or beginner work has issue labels.
89
+ See below for how to find work that isn't labelled.
90
+
91
+ [ help-wanted-search ] : https://github.com/issues?q=is%3Aopen+is%3Aissue+org%3Arust-lang+no%3Aassignee+label%3AE-easy%2C%22good+first+issue%22%2Cgood-first-issue%2CE-medium%2CE-help-wanted%2CE-mentor
92
+ [ Triage ] : ./contributing.md#issue-triage
93
+
94
+ ### Recurring work
95
+
96
+ Some work is too large to be done by a single person. In this case, it's commmon to have "Tracking
97
+ issues" to co-ordinate the work between contributors. Here are some example tracking issues where
98
+ it's easy to pick up a work without a large time commitment:
99
+
100
+ - [ Rustdoc Askama Migration] ( https://github.com/rust-lang/rust/issues/108868 )
101
+ - [ Diagnostic Translation] ( https://github.com/rust-lang/rust/issues/100717 )
102
+ - [ Move UI tests to subdirectories] ( https://github.com/rust-lang/rust/issues/73494 )
103
+
104
+ If you find more recurring work, please feel free to add it here!
76
105
77
- ## Contributing code to other Rust projects
106
+ ### Clippy issues
107
+
108
+ The [ Clippy] project has spent a long time making its contribution process as friendly to newcomers
109
+ as possible. Consider working on it first to get familiar with the process and the compiler
110
+ internals.
111
+
112
+ See [ the Clippy contribution guide] [ clippy-contributing ] for instructions on getting started.
113
+
114
+ [ Clippy ] : https://doc.rust-lang.org/clippy/
115
+ [ clippy-contributing ] : https://github.com/rust-lang/rust-clippy/blob/master/CONTRIBUTING.md
116
+
117
+ ### Diagnostic issues
118
+
119
+ Many diagnostic issues are self-contained and don't need detailed background knowledge of the
120
+ compiler. You can see a list of diagnostic issues [ here] [ diagnostic-issues ] .
121
+
122
+ [ diagnostic-issues ] : https://github.com/rust-lang/rust/issues?q=is%3Aissue+is%3Aopen+label%3AA-diagnostics+no%3Aassignee
123
+
124
+ ### Contributing code to other Rust projects
78
125
79
126
There are a bunch of other projects that you can contribute to outside of the
80
- ` rust-lang/rust ` repo, including ` clippy ` , ` miri ` , ` chalk ` , and many others.
127
+ ` rust-lang/rust ` repo, including ` cargo ` , ` miri ` , ` rustup ` , and many others.
81
128
82
129
These repos might have their own contributing guidelines and procedures. Many
83
130
of them are owned by working groups (e.g. ` chalk ` is largely owned by
84
131
WG-traits). For more info, see the documentation in those repos' READMEs.
85
132
86
- ## Other ways to contribute
133
+ ### Other ways to contribute
87
134
88
135
There are a bunch of other ways you can contribute, especially if you don't
89
136
feel comfortable jumping straight into the large ` rust-lang/rust ` codebase.
@@ -118,9 +165,13 @@ incredibly helpful:
118
165
[ wg ] : https://rust-lang.github.io/compiler-team/working-groups/
119
166
[ triage ] : ./contributing.md#issue-triage
120
167
168
+ ## Cloning and Building
169
+
170
+ See [ "How to build and run the compiler"] ( ./building//how-to-build-and-run.md ) .
171
+
121
172
## Contributor Procedures
122
173
123
- This section has moved to the [ "Contribution Procedures"] ( ./contributing.md ) chapter.
174
+ This section has moved to the [ "Contribution Procedures"] ( ./contributing.mD ) chapter.
124
175
125
176
## Other Resources
126
177
0 commit comments