|
| 1 | +# Preparing an Issue |
| 2 | + |
| 3 | +Most activity on the p5.js Editor’s GitHub happens in issues. Issues are GitHub posts which can contain bug reports, feature requests, or broader discussions about the development of the p5.js Editor. It’s a great place to begin contributing. |
| 4 | + |
| 5 | +## Filing a New Issue |
| 6 | + |
| 7 | +To file a new issue: |
| 8 | + |
| 9 | +1. Visit the [Issues](https://github.com/processing/p5.js-web-editor/issues) tab on the repository. |
| 10 | + |
| 11 | +2. Click the green 'New Issue' button on the right. |
| 12 | + |
| 13 | +3. A modal should appear with several templates for the type of issue you would like to open. Choose the one that best matches what you're looking for (i.e Bug Report, Feature Request). |
| 14 | + |
| 15 | +4. Fill out the form as in-depth as you can. It helps to be as clear and specific as you can in your language and supporting information. Some ways to achieve that is by including screenshots, code snippets, or steps to exactly reproduce a scenario! Doing this helps maintainers and other contributors understand and respond to your issue more quickly and accurately. |
| 16 | + |
| 17 | +More in-depth information about filing an issue can be found within the [p5.js Library Documentation for Issue Templates](https://github.com/processing/p5.js/blob/main/contributor_docs/contributor_guidelines.md#issue-templates). |
| 18 | + |
| 19 | +## Navigating Existing Issues |
| 20 | + |
| 21 | +### Project Board |
| 22 | +Many issues are related to each other and fall under bigger projects. To get a bigger picture, look at the [All Projects](https://github.com/processing/p5.js-web-editor/projects/) board. |
| 23 | + |
| 24 | +### Searching and Filtering |
| 25 | +If you're looking for issues to work on, a good place to start is with tickets labeled [high priority](https://github.com/processing/p5.js-web-editor/labels/priority%3Ahigh). You can also look for tickets that are [feature enhancements](https://github.com/processing/p5.js-web-editor/labels/type%3Afeature), [bug fixes](https://github.com/processing/p5.js-web-editor/labels/type%3Abug), and a few other tags. |
| 26 | + |
| 27 | +If you feel like an issue is tagged incorrectly (e.g. it's low priority and you think it should be high), please update the issue! |
| 28 | + |
| 29 | +--- |
| 30 | + |
| 31 | +## Understanding Issue Labels |
| 32 | + |
| 33 | +Labels help categorize issues and makes them easier to find and sort. You can browse the full list in our [Issue Labels](https://github.com/processing/p5.js-web-editor/labels), but here are a few helpful ones to understand early on: |
| 34 | + |
| 35 | +### Good First Issues |
| 36 | +For first-time contributors or those who want to start with a small task, [check out the list of good first issues](https://github.com/processing/p5.js-web-editor/labels/good%20first%20issue), or [issues that need documentation of steps to reproduce](https://github.com/processing/p5.js-web-editor/issues?q=is%3Aissue+is%3Aopen+label%3A%22needs+steps+to+reproduce%22). It's okay to not know how to fix an issue—feel free to ask questions about to approach the problem! |
| 37 | + |
| 38 | +### Good Medium Issues |
| 39 | +If you're looking for a bigger project to take on, look through the issues tagged [good medium issue](https://github.com/processing/p5.js-web-editor/labels/good%20medium%20issue). These issues are self-contained projects that may take longer to work on, but are great if you're looking to get more deeply involved in contributing! |
| 40 | + |
| 41 | +### Awaiting Maintainer Approval |
| 42 | +All new issues opened on the p5.js editor repository will automatically have the 'Awaiting Maintainer Approval' label. This means that the issue needs review or confirmation from a maintainer before moving forward. |
| 43 | + |
| 44 | +If you see an issue with this label, it's best to hold off on development until it's been approved and has the 'Ready for Work' label. |
| 45 | + |
| 46 | +### Ready for Work |
| 47 | +This label means the issue has been reviewed and is ready to be picked up! If it's not assigned to anyone yet, you can leave a comment expressing your interest and asked to be assigned. |
| 48 | + |
| 49 | +If you see an issue that does not have this label but you feel that it might be ready for development, feel free to comment on it! |
| 50 | + |
| 51 | +### Help Wanted |
| 52 | + |
| 53 | +These issues need additional input, ideas, or code contributions from the community. If you're looking to get involved, this is also a great place to start. |
0 commit comments