You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Hello! We welcome community contributions to the p5.js Web Editor. Contributing takes many forms and doesn't have to be **writing code**, it can be **report bugs**, **proposing new features**, **creating UI/UX designs**, and **updating documentation**.
4
-
5
-
Here are links to all the sections in this document:
6
-
7
-
<!-- If you change any of the headings in this document, remember to update the table of contents. -->
3
+
Hello! We welcome community contributions to the p5.js Web Editor. Contributing takes many forms and doesn't have to be **writing code**, it can be **reporting bugs**, **proposing new features**, **creating UI/UX designs**, and **updating documentation**.
8
4
5
+
## Table of Contents
9
6
-[Contributing to the p5.js Web Editor](#contributing-to-the-p5js-web-editor)
7
+
-[Table of Contents](#table-of-contents)
10
8
-[Code of Conduct](#code-of-conduct)
11
9
-[How Can I Contribute?](#how-can-i-contribute)
12
-
-[First Timers](#first-timers)
13
-
-[Milestones](#milestones)
10
+
-[First Steps](#first-steps)
11
+
-[Good First Issues](#good-first-issues)
12
+
-[Good Medium Issues](#good-medium-issues)
13
+
-[Project Board](#project-board)
14
14
-[Project Ideas](#project-ideas)
15
15
-[Issue Search and Tagging](#issue-search-and-tagging)
Please follow the guidelines mentioned at [CODE OF CONDUCT.md](https://github.com/processing/p5.js-web-editor/blob/master/.github/CODE_OF_CONDUCT.md).
21
+
Please follow the guidelines in the [Code of Conduct](https://github.com/processing/p5.js-web-editor/blob/master/.github/CODE_OF_CONDUCT.md).
24
22
25
23
## How Can I Contribute?
26
-
27
-
### First Timers
28
-
For first-time contributors or those who want to start with a small task: [check out our list of good first bugs](https://github.com/processing/p5.js-web-editor/labels/good%20first%20issue). First read the github discussion on that issue and find out if there's currently a person working on that or not. If no one is working on it or if there has was one claimed to but has not been active for a while, ask if it is up for grabs. It's okay to not know how to fix an issue and feel free to ask questions about to approach the problem! We are all just here to learn and make something awesome. Someone from the community would help you out and these are great issues for learning about the web editor, its file structure and its development process.
29
-
30
-
### Milestones
31
-
A good place to check for tickets to work on is [milestones](https://github.com/processing/p5.js-web-editor/milestones), as miletones have a due date, and will give you a sense of tickets the tickets that maintainers would like to be completed sooner rather than later.
24
+
If you're new to open source, [read about how to contribute to open source](https://opensource.guide/how-to-contribute/).
25
+
26
+
### First Steps
27
+
Don't know where to begin? Here are some suggestions to get started:
28
+
* Think about what you're hoping to learn by working on open source. The web editor is a full-stack web application, therefore there's tons of different areas to focus on:
- DevOps: Travis CI, Jest, Docker, Kubernetes, AWS
34
+
- Documentation
35
+
- Translations: Application and documentation
36
+
* Use the [p5.js Web Editor](https://editor.p5js.org)! Find a bug? Think of something you think would add to the project? Open an issue.
37
+
* Expand an existing issue. Sometimes issues are missing steps to reproduce, or need suggestions for potential solutions. Sometimes they need another voice saying, "this is really important!"
38
+
* Try getting the project running locally on your computer by following the [installation steps](./../developer_docs/installation.md).
39
+
* Look through the documentation in the [developer docs](../developer_docs/). Is there anything that could be expanded? Is there anything missing?
40
+
* Look at the [development guide](./../developer_docs/development.md).
41
+
42
+
### Good First Issues
43
+
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). If the issue has not been assigned to anyone, then you can work on it! It's okay to not know how to fix an issue, and feel free to ask questions about to approach the problem! We are all here to learn and make something awesome. Someone from the community would help you out and these are great issues for learning about the web editor, its file structure and its development process.
44
+
45
+
### Good Medium Issues
46
+
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!
47
+
48
+
### Project Board
49
+
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/4) board.
32
50
33
51
### Project Ideas
34
52
If you're looking for inspiration for Google Summer of Code or a bigger project, there's a [project list](https://github.com/processing/processing/wiki/Project-List#p5js-web-editor) maintained on the Processing wiki.
@@ -40,47 +58,11 @@ If you feel like an issue is tagged incorrectly (e.g. it's low priority and you
40
58
41
59
### Beginning Work
42
60
43
-
If you'd like to work on an issue, please comment on it to let the maintainers know. If someone else has already commented and taken up that issue, please refrain from working on it and submitting a PR without asking the maintainers as it leads to unnecessary duplication of effort.
61
+
If you'd like to work on an issue, please comment on it to let the maintainers know, so that they can assign it to you. If someone else has already commented and taken up that issue, please refrain from working on it and submitting a PR without asking the maintainers as it leads to unnecessary duplication of effort.
44
62
45
-
Then, follow the [installation guide](https://github.com/processing/p5.js-web-editor/blob/master/developer_docs/installation.md) to get the project building and working on your computer.
63
+
Then, look at the [development guide](https://github.com/processing/p5.js-web-editor/blob/master/developer_docs/development.md)for instructions on how to install the project locally and follow the right development workflow.
Good commit messages serve at least three important purposes:
55
-
56
-
* They speed up the reviewing process.
57
-
* They help us write good release notes.
58
-
* They help future maintainers understand your change and the reasons behind it.
59
-
60
-
Structure your commit message like this:
61
-
62
-
```
63
-
Short (50 chars or less) summary of changes ( involving Fixes #Issue-number keyword )
64
-
65
-
More detailed explanatory text, if necessary. Wrap it to about 72
66
-
characters or so. In some contexts, the first line is treated as the
67
-
subject of an email and the rest of the text as the body. The blank
68
-
line separating the summary from the body is critical (unless you omit
69
-
the body entirely); tools like rebase can get confused if you run the
70
-
two together.
71
-
72
-
Further paragraphs come after blank lines.
73
-
74
-
- Bullet points are okay, too
75
-
76
-
- Typically a hyphen or asterisk is used for the bullet, preceded by a
77
-
single space, with blank lines in between, but conventions vary here
78
-
```
79
-
80
-
* Write the summary line and description of what you have done in the imperative mode, that is as if you were commanding someone. Start the line with "Fix", "Add", "Change" instead of "Fixed", "Added", "Changed".
81
-
* Always leave the second line blank.
82
-
* Be as descriptive as possible in the description. It helps reasoning about the intention of commits and gives more context about why changes happened.
83
-
84
-
## Tips
85
-
86
-
* If it seems difficult to summarize what your commit does, it may be because it includes several logical changes or bug fixes, and are better split up into several commits using `git add -p`.
Copy file name to clipboardExpand all lines: .github/config.yml
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ newIssueWelcomeComment: >
10
10
11
11
# Comment to be posted to on PRs from first time contributors in your repository
12
12
newPRWelcomeComment: >
13
-
🎉 Thanks for opening this pull request! Please check out our [contributing guidelines](https://github.com/processing/p5.js-web-editor/blob/master/CONTRIBUTING.md) if you haven't already.
13
+
🎉 Thanks for opening this pull request! Please check out our [contributing guidelines](https://github.com/processing/p5.js-web-editor/blob/master/.github/CONTRIBUTING.md) if you haven't already.
14
14
15
15
# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge
0 commit comments