Skip to content

Commit b2dc130

Browse files
authored
Merge pull request #8656 from processing/ksen0-patch-2
Update contributor guidelines for issue usage and labels
2 parents 67e623b + a3fe7a3 commit b2dc130

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

contributor_docs/contributor_guidelines.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,14 +60,22 @@ The majority of the activity on p5.js' GitHub repositories (repo for short) happ
6060

6161
“Issue” is the generic name for a post on GitHub that aims to describe, well, an issue. This issue can be a bug report, a request to add a new feature, a discussion, or anything that works as a post related to p5.js library development. Comments can be added below each issue by anyone with a GitHub account, including bots! It is the place where contributors discuss topics related to the development of the project in the repo.
6262

63-
While an issue can be opened for a wide variety of reasons, we usually only use issues to discuss the development of p5.js source code. Topics such as debugging your own code, inviting collaborators to your project, or other unrelated topics should be discussed
64-
65-
either on the [forum](https://discourse.processing.org) or on other platforms such as [Discord](https://discord.p5js.org).
63+
We only use issues to discuss the development of p5.js source code. Topics such as debugging your own code, inviting collaborators to your project, or other unrelated topics should be discussed either on the [forum](https://discourse.processing.org) or on other platforms such as [the p5.js Discord server](https://discord.p5js.org).
6664

6765
We have created easy-to-use issue templates to aid you in deciding whether a topic should be a GitHub issue or posted elsewhere!
6866

67+
## Find issues using labels
68+
69+
Looking for an issue to work on? We use labels to show which issues are ready for work. There are many labels on reach repository: for example, these are the [p5.js library repository labels](https://github.com/processing/p5.js/labels/), and these are the [p5.js-website repository labels](https://github.com/processing/p5.js-website/labels/).
70+
71+
Below are the most important labels you can look for:
72+
73+
* "[Community Input Needed](https://github.com/processing/p5.js/issues?q=state%3Aopen%20label%3A%22Community%20Input%20Needed%22)" issues invite community discussion. These are not ready for implementation, but they welcome new pespectives.
74+
* "[Good First Issue](https://github.com/processing/p5.js/issues?q=state%3Aopen%20label%3A%22Good%20First%20Issue%22)" issues are best for new contributors; if you have already contributed to p5.js, please leave these to newcomers.
75+
* "[Help Wanted](https://github.com/processing/p5.js/issues?q=state%3Aopen%20label%3A%22Help%20Wanted%22)" issues are ready for implementation! These welcome both established and new code contributors to p5.js.
76+
* "[Technical Initiative](https://github.com/processing/p5.js/issues?q=state%3Aopen%20label%3A%22Technical%20Initiative%22)" issues are reserved for established contributors. These are larger technical tasks that require both creativity, and familiarity with a particular part of the codebase. Maintainers will assign based not only on order, but also on whether a volunteer has made significant previous work in a related area.
6977

70-
## Issue templates
78+
## Make new issues using templates
7179

7280
p5.js's issue templates make it easier for stewards and maintainers to understand and review issues. They also make it easier for you to file the relevant issue and receive a reply faster. 
7381

0 commit comments

Comments
 (0)