Skip to content

Commit 9f3cffc

Browse files
Add 'Finding ways to help' to CONTRIBUTING.md (#20567)
Co-authored-by: Alex Waygood <[email protected]>
1 parent 21be94a commit 9f3cffc

File tree

1 file changed

+29
-15
lines changed

1 file changed

+29
-15
lines changed

CONTRIBUTING.md

Lines changed: 29 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,35 @@ Welcome! We're happy to have you here. Thank you in advance for your contributio
77
> This guide is for Ruff. If you're looking to contribute to ty, please see [the ty contributing
88
> guide](https://github.com/astral-sh/ruff/blob/main/crates/ty/CONTRIBUTING.md).
99
10-
## The Basics
11-
12-
Ruff welcomes contributions in the form of pull requests.
13-
14-
For small changes (e.g., bug fixes), feel free to submit a PR.
15-
16-
For larger changes (e.g., new lint rules, new functionality, new configuration options), consider
17-
creating an [**issue**](https://github.com/astral-sh/ruff/issues) outlining your proposed change.
18-
You can also join us on [Discord](https://discord.com/invite/astral-sh) to discuss your idea with the
19-
community. We've labeled [beginner-friendly tasks](https://github.com/astral-sh/ruff/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
20-
in the issue tracker, along with [bugs](https://github.com/astral-sh/ruff/issues?q=is%3Aissue+is%3Aopen+label%3Abug)
21-
and [improvements](https://github.com/astral-sh/ruff/issues?q=is%3Aissue+is%3Aopen+label%3Aaccepted)
22-
that are ready for contributions.
23-
24-
If you have suggestions on how we might improve the contributing documentation, [let us know](https://github.com/astral-sh/ruff/discussions/5693)!
10+
## Finding ways to help
11+
12+
We label issues that would be good for a first time contributor as
13+
[`good first issue`](https://github.com/astral-sh/ruff/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22).
14+
These usually do not require significant experience with Rust or the Ruff code base.
15+
16+
We label issues that we think are a good opportunity for subsequent contributions as
17+
[`help wanted`](https://github.com/astral-sh/ruff/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22).
18+
These require varying levels of experience with Rust and Ruff. Often, we want to accomplish these
19+
tasks but do not have the resources to do so ourselves.
20+
21+
You don't need our permission to start on an issue we have labeled as appropriate for community
22+
contribution as described above. However, it's a good idea to indicate that you are going to work on
23+
an issue to avoid concurrent attempts to solve the same problem.
24+
25+
Please check in with us before starting work on an issue that has not been labeled as appropriate
26+
for community contribution. We're happy to receive contributions for other issues, but it's
27+
important to make sure we have consensus on the solution to the problem first.
28+
29+
Outside of issues with the labels above, issues labeled as
30+
[`bug`](https://github.com/astral-sh/ruff/issues?q=is%3Aopen+is%3Aissue+label%3A%22bug%22) are the
31+
best candidates for contribution. In contrast, issues labeled with `needs-decision` or
32+
`needs-design` are _not_ good candidates for contribution. Please do not open pull requests for
33+
issues with these labels.
34+
35+
Please do not open pull requests for new features without prior discussion. While we appreciate
36+
exploration of new features, we will often close these pull requests immediately. Adding a
37+
new feature to ruff creates a long-term maintenance burden and requires strong consensus from the ruff
38+
team before it is appropriate to begin work on an implementation.
2539

2640
### Prerequisites
2741

0 commit comments

Comments
 (0)