@@ -70,20 +70,64 @@ 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. See below for how to find work that isn't labelled.
89
+
90
+ [ 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
91
+ [ Triage ] : ./contributing.md#issue-triage
92
+
93
+ ### Recurring work
94
+
95
+ Some work is too large to be done by a single person. In this case, it's commmon to have "Tracking issues" to co-ordinate the work between contributors.
96
+ Here are some example tracking issues where it's easy to pick up a work without a large time commitment:
97
+
98
+ - [ Rustdoc Askama Migration] ( https://github.com/rust-lang/rust/issues/108868 )
99
+ - [ Diagnostic Translation] ( https://github.com/rust-lang/rust/issues/100717 )
100
+ - [ Move UI tests to subdirectories] ( https://github.com/rust-lang/rust/issues/73494 )
101
+
102
+ If you find more recurring work, please feel free to add it here!
76
103
77
- ## Contributing code to other Rust projects
104
+ ### Clippy issues
105
+
106
+ The [ Clippy] project has spent a long time making its contribution process as friendly to newcomers as possible.
107
+ Consider working on it first to get familiar with the process and the compiler internals.
108
+
109
+ See [ the Clippy contribution guide] [ clippy-contributing ] for instructions on getting started.
110
+
111
+ [ Clippy ] : https://doc.rust-lang.org/clippy/
112
+ [ clippy-contributing ] : https://github.com/rust-lang/rust-clippy/blob/master/CONTRIBUTING.md
113
+
114
+ ### Diagnostic issues
115
+
116
+ Many diagnostic issues are self-contained and don't need detailed background knowledge of the
117
+ compiler. You can see a list of diagnostic issues [ here] [ diagnostic-issues ] .
118
+
119
+ [ diagnostic-issues ] : https://github.com/rust-lang/rust/issues?q=is%3Aissue+is%3Aopen+label%3AA-diagnostics+no%3Aassignee
120
+
121
+ ### Contributing code to other Rust projects
78
122
79
123
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.
124
+ ` rust-lang/rust ` repo, including ` cargo ` , ` miri ` , ` rustup ` , and many others.
81
125
82
126
These repos might have their own contributing guidelines and procedures. Many
83
127
of them are owned by working groups (e.g. ` chalk ` is largely owned by
84
128
WG-traits). For more info, see the documentation in those repos' READMEs.
85
129
86
- ## Other ways to contribute
130
+ ### Other ways to contribute
87
131
88
132
There are a bunch of other ways you can contribute, especially if you don't
89
133
feel comfortable jumping straight into the large ` rust-lang/rust ` codebase.
@@ -118,9 +162,13 @@ incredibly helpful:
118
162
[ wg ] : https://rust-lang.github.io/compiler-team/working-groups/
119
163
[ triage ] : ./contributing.md#issue-triage
120
164
165
+ ## Cloning and Building
166
+
167
+ See [ "How to build and run the compiler"] ( ./building//how-to-build-and-run.md ) .
168
+
121
169
## Contributor Procedures
122
170
123
- This section has moved to the [ "Contribution Procedures"] ( ./contributing.md ) chapter.
171
+ This section has moved to the [ "Contribution Procedures"] ( ./contributing.mD ) chapter.
124
172
125
173
## Other Resources
126
174
0 commit comments