From b1781abffb1d603529b1d8713d4306b1ad8ced08 Mon Sep 17 00:00:00 2001 From: konsti Date: Thu, 13 Jul 2023 12:42:09 +0200 Subject: [PATCH] Link issue tracker in contributing docs (#5688) ## Summary This adds links to issue categories that are good for people looking to implement something and a link to the contributing guide feedback issue (https://github.com/astral-sh/ruff/issues/5684) --------- Co-authored-by: Zanie --- CONTRIBUTING.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 87cf63b9e6..6864a7ecd1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,7 +23,9 @@ For small changes (e.g., bug fixes), feel free to submit a PR. For larger changes (e.g., new lint rules, new functionality, new configuration options), consider creating an [**issue**](https://github.com/astral-sh/ruff/issues) outlining your proposed change. You can also join us on [**Discord**](https://discord.gg/c9MhzV8aU5) to discuss your idea with the -community. +community. We have labeled [beginner-friendly tasks in the issue tracker](https://github.com/astral-sh/ruff/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) +as well as [bugs](https://github.com/astral-sh/ruff/issues?q=is%3Aissue+is%3Aopen+label%3Abug) and +[improvements that are ready for contributions](https://github.com/astral-sh/ruff/issues?q=is%3Aissue+is%3Aopen+label%3Aaccepted). If you're looking for a place to start, we recommend implementing a new lint rule (see: [_Adding a new lint rule_](#example-adding-a-new-lint-rule), which will allow you to learn from and @@ -34,6 +36,8 @@ As a concrete example: consider taking on one of the rules from the [`flake8-pyi plugin, and looking to the originating [Python source](https://github.com/PyCQA/flake8-pyi) for guidance. +If you have suggestions on how we might improve the contributing documentation, [let us know](https://github.com/astral-sh/ruff/discussions/5693)! + ### Prerequisites Ruff is written in Rust. You'll need to install the