Description
How Do I Get Started?
If you haven't already, check out these resources and guides below to get started with contributing to the p5.js Editor!
- Community Statement and Code of Conduct
- Getting Started with Contribution
- Preparing an Issue
- Preparing a Pull Request
- Contribution Guidelines for the p5.js Editor
- Adding Translations (Note: I'm adding this here since this is a popular touchpoint for folks to start with! If you plan to add translations, please check this out first!)
What Issues Can I Work On?
The best way to verify if an issue is ready to be worked on is checking if it has the Ready for Work label. To learn more about our labels and what they mean, check out All Labels.
Before beginning work on a code contribution, please make sure that:
- The issue does not have a Awaiting Maintainer Approval label, has been discussed, and a proposed solution has been agreed upon.
- You have been assigned to the issue.
- If an implementation has been agreed upon but no one has volunteered to take it on, feel free to comment and offer to help. A maintainer can then assign the issue to you.
Please do not open a pull request for an issue that is already assigned to someone else. We follow a “first assigned, first served” approach to avoid duplicated work. If you open a PR for an issue that someone else is already working on, your PR will be closed.
If an issue has been inactive for a long time, you’re welcome to check in politely by commenting to see if the assignee still plans to work on it or would be open to someone else taking over.
There’s no hard deadline for completing contributions. We understand that people often contribute on a volunteer basis and timelines may vary. That said, if you run into trouble or have questions at any point, don’t hesitate to ask for help in the issue thread. Maintainers and other community members are here to support you.
When Will My Pull Request Get Reviewed?
We do our best to review pull requests within two weeks of submission. That said, there may be occasional delays. If you haven’t heard back in a while, feel free to leave a friendly comment on your pull request to check in!
Why Was My Pull Request Rejected?
In some cases, a pull request may be declined. This can happen if:
- It doesn’t align with the project’s mission or community guidelines
- It introduces significant maintenance or implementation challenges
- It falls outside the current scope or direction of the project
- It is not associated with an issue. (Pull requests that do not have an associated issue will not be accepted)
If your contribution isn’t accepted, please know it’s not a reflection of you. We deeply value every effort to support the project, and learning through contribution is still a meaningful success.
Thanks for your patience and understanding—we truly appreciate your time and energy in contributing to the p5.js Editor!
When Will the Next Production Release Be?
We aim to deploy PATCH releases on a bi-weekly basis, and MINOR releases every 1-2 months. Check out all of our releases on the Releases page!
You can read more about Semantic Versioning and the differences between a MINOR and PATCH release.
What Does the Current Develop Branch Look Like?
Sometimes, changes might be merged into the develop branch that won't be visible on the p5.js editor for a while. To see the current state of the develop branch, run the repository locally by following the Installation Guide.
Please feel free to note any other suggestions or concerns with the information above, thanks!