Skip to content

Commit 34b9b40

Browse files
committed
CONTRIBUTING GUIDE: add section about finding issues to work on for code contributions
1 parent ff203dc commit 34b9b40

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

.github/CONTRIBUTING.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Thank you for your interest in contributing to PHP_CodeSniffer!
1515
* [Other tasks](#other-tasks)
1616
* [Contributing With Code](#contributing-with-code)
1717
* [Requesting/Submitting New Features](#requestingsubmitting-new-features)
18+
* [Finding Something to Work on](#finding-something-to-work-on)
1819
* [Getting started](#getting-started)
1920
* [While working on a patch](#while-working-on-a-patch)
2021
* [Writing tests](#writing-tests)
@@ -24,7 +25,7 @@ Thank you for your interest in contributing to PHP_CodeSniffer!
2425

2526
## Reporting Bugs
2627

27-
Please search the [open issues](https://github.com/PHPCSStandards/PHP_CodeSniffer/issues) to see if your issue has been reported
28+
Please search the [open issues][issuelist] to see if your issue has been reported
2829
already and if so, comment in that issue if you have additional information, instead of opening a new one.
2930

3031
Before reporting a bug, you should check what sniff an error is coming from.
@@ -217,6 +218,28 @@ a duplicate issue/PR.
217218
> in PHP_CodeSniffer and may be better suited to an external standard.
218219
219220

221+
### Finding Something to Work on
222+
223+
The [open issue list][issuelist] is a good place to start :wink:
224+
225+
As a rule of thumb, you can use the following to find an issue to work on:
226+
* Issues which have been triaged already and are not marked as "blocked", "close candidate" or "waiting for opinions".
227+
* Issues which don't have anyone assigned to them (nor a comment in the ticket from someone saying
228+
they are working on the ticket).
229+
* Issues which have no (far in the future) milestone attached.
230+
231+
This largely translates to this [filtered issue list](https://github.com/PHPCSStandards/PHP_CodeSniffer/issues?q=is%3Aopen+is%3Aissue+no%3Aassignee+-label%3A%22Status%3A+triage%22+-label%3A%22Status%3A+close+candidate%22+-label%3A%22Status%3A+blocked%22+-label%3A%22Status%3A+waiting+for+opinions%22+no%3Amilestone+).
232+
233+
You can, of course, filter this list down further by selecting/excluding additional labels, like, for example,
234+
filtering on "Type: bug", "Status: good first issue" or "Status: help wanted".
235+
236+
If you expect the work on the ticket to take a little while, please leave a comment on the ticket to indicate that
237+
you will be working on it. This is a good practice to prevents duplicate work/multiple people working on the same ticket.
238+
239+
When in doubt how to proceed with a ticket, feel free to leave a comment with specific questions and ask for guidance
240+
(if still needed after you have read the rest of the contributing guide).
241+
242+
220243
### Getting started
221244

222245
1. Fork/clone the repository.
@@ -383,3 +406,5 @@ Submitting a (largely) AI-generated PR will lead to you being banned from the re
383406

384407
By contributing code to this repository, you agree to license your code for use under the
385408
[BSD-3-Clause license](https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt).
409+
410+
[issuelist]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues

0 commit comments

Comments
 (0)