|
1 |
| -This folder contains documents intended for developers of the p5.js Web Editor. |
| 1 | +# Contributor Documentatation |
| 2 | +This folder contains guides for contributing to the p5.js Web Editor. You don't need to know everything to get started—explore at your own pace! To begin, we highly recommend starting with the [Contribution Guide](https://github.com/processing/p5.js-web-editor/blob/develop/.github/CONTRIBUTING.md)! |
| 3 | + |
| 4 | +These guides aren't exhaustive, and do not cover all the possible ways you can contribute to a project. If you have an idea for how you'd like to help and don't see a guide for it here, you're welcome to add it to the "Documents to Create" list below by opening an issue! |
| 5 | + |
2 | 6 |
|
3 | 7 | ## List of Documents
|
4 | 8 | * [Contribution Guide](https://github.com/processing/p5.js-web-editor/blob/develop/.github/CONTRIBUTING.md) - A place to get started!
|
5 |
| -* [Installation](installation.md) - A guide for setting up your development environment |
6 |
| -* [Development](development.md) - A guide for adding code to the web editor |
7 |
| -* [Testing](./testing.md) - A guide for writing and running tests in the codebase |
8 |
| -* [Preparing a pull-request](preparing_a_pull_request.md) - Instructions for how to make a pull-request |
9 |
| -* [Accessibility Guidelines](accessibility.md) - Guidelines for writing code to create an accessible application |
10 |
| -* [Translations Guidelines](translations.md) - Guidelines for translating the application |
| 9 | +* [Installation](installation.md) - A guide for setting up your development environment. |
| 10 | +* [Development](development.md) - A guide for contributing code to the codebase. |
| 11 | +* [Testing](./testing.md) - A guide for writing and running tests in the codebase. |
| 12 | +* [Preparing a pull-request](preparing_a_pull_request.md) - Instructions for making a pull-request. |
| 13 | +* [Accessibility Guidelines](accessibility.md) - Guidelines for writing code to create an accessible application. |
| 14 | +* [Translations Guidelines](translations.md) - Guidelines for translating the p5.js editor. |
11 | 15 | * [Deployment](deployment.md) - A guide to production deployment, and all platforms that are being used.
|
12 | 16 | * [Release](./release.md) - A guide to creating a production release.
|
13 | 17 |
|
| 18 | + |
14 | 19 | ## Documents to Create
|
15 | 20 | * Software Design Principles - reference [p5.js software design principles](https://github.com/processing/p5.js/blob/eb61f7a260531d17930de3c987949558ce242d35/contributor_docs/contributor_guidelines.md#software-design-principles)
|
16 | 21 | * Issue Templates - reference [p5.js issue templates](https://github.com/processing/p5.js/blob/main/contributor_docs/contributor_guidelines.md#issue-templates)
|
|
0 commit comments