5.3 KiB
Contributing to the p5.js Web Editor
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.
Table of Contents
Code of Conduct
Please follow the guidelines in the Code of Conduct.
How Can I Contribute?
If you're new to open source, read about how to contribute to open source.
First Steps
Don't know where to begin? Here are some suggestions to get started:
- 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:
- UI/UX design
- Project management: Organizing tickets, pull requests, tasks
- Front end: React/Redux, CSS/Sass, CodeMirror
- Back end: Node, Express, MongoDB, Jest, AWS
- DevOps: Travis CI, Jest, Docker, Kubernetes, AWS
- Documentation
- Translations: Application and documentation
- Use the p5.js Web Editor! Find a bug? Think of something you think would add to the project? Open an issue.
- 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!"
- Try getting the project running locally on your computer by following the installation steps.
- Look through the documentation in the developer docs. Is there anything that could be expanded? Is there anything missing?
- Look at the development guide.
Good First Issues
For first-time contributors or those who want to start with a small task, check out the list of good first issues, or issues that need documentation of steps to reproduce. 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.
Good Medium Issues
If you're looking for a bigger project to take on, look through the issues tagged good medium issue. 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!
Project Board
Many issues are related to each other and fall under bigger projects. To get a bigger picture, look at the All Projects board.
Project Ideas
If you're looking for inspiration for Google Summer of Code or a bigger project, there's a project list maintained on the Processing wiki.
Issue Search and Tagging
If you're looking for issues to work on, a good place to start is with tickets labeled high priority. You can also look for tickets that are feature enhancements, bug fixes, and a few other tags.
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!
Beginning Work
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.
Then, look at the development guide for instructions on how to install the project locally and follow the right development workflow.