Skip to content

Commit d498da5

Browse files
committed
add issue documentation, update PR docs
1 parent 602c426 commit d498da5

File tree

2 files changed

+66
-2
lines changed

2 files changed

+66
-2
lines changed

contributor_docs/preparing_a_pull_request.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,17 @@
1-
# Preparing a pull request
1+
# Preparing a Pull Request
22

33
Copied and updated from the [p5.js repository](https://github.com/processing/p5.js).
44

5-
Pull-requests are easier when your code is up to date! You can use git rebase to update your code to incorporate changes from other contributors. Here's how.
5+
Pull-requests are easier when your code is up to date!
6+
7+
## Before Submitting a Pull Request
8+
Before submitting a pull request, make sure that:
9+
10+
- Your work is related to an issue. **Pull requests that do not have an associated issue will not be accepted.**
11+
- Your work adheres to the style guidelines and fits in with the rest of the codebase.
12+
- You ran the project locally and tested your changes. Pay special attention to any specific areas of the p5.js editor that may be affected by your changes. Does everything still work as before? Great!
13+
14+
Once that's done, you can use git rebase to update your code to incorporate changes from other contributors. Here's how.
615

716
## Save and Update
817

@@ -40,6 +49,9 @@ Then ask git about the latest changes.
4049
### Verifies what git will be committing
4150
git status
4251

52+
## Pull Request Templates
53+
Once you've opened your pull request, please ensure that you follow the guidelines and
54+
4355
## CONFLICTS
4456
You may have some conflicts! It's okay. Feel free to ask for help. If merging with the latest upstream `develop` branch causes conflicts, you can always make a pull request with the upstream repository, which makes the merge conflicts public.
4557

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
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+
18+
## Navigating Existing Issues
19+
20+
### Project Board
21+
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.
22+
23+
### Searching and Filtering
24+
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.
25+
26+
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!
27+
28+
---
29+
30+
## Understanding Issue Labels
31+
32+
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:
33+
34+
### Good First Issues
35+
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!
36+
37+
### Good Medium Issues
38+
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!
39+
40+
### Awaiting Maintainer Approval
41+
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.
42+
43+
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.
44+
45+
### Ready for Work
46+
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.
47+
48+
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!
49+
50+
### Help Wanted
51+
52+
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

Comments
 (0)