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
Copy file name to clipboardExpand all lines: developer_docs/README.md
+5-5Lines changed: 5 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ Hello! Thanks for your interest in contributing to p5.js! You can get started wi
12
12
13
13
# How To Contribute
14
14
15
-
Known bugs and intended new features are tracked using [GitHub issues](https://github.com/processing/p5.js/issues). Issue [labels](https://github.com/processing/p5.js/blob/master/developer_docs/issue_labels.md) are used to sort issues into categories, such as those which are [suitable for beginners](https://github.com/processing/p5.js/labels/level%3Abeginner). If you'd like to start working on an existing issue, comment on the issue that you plan to work on it so other contributors know it's being handled and can offer help. Once you have completed your work on this issue, [submit a pull request (PR)](https://github.com/processing/p5.js/blob/master/developer_docs/preparing_a_pull_request.md) against the p5.js master branch. In the description field of the PR, include "resolves #XXXX" tagging the issue you are fixing. If the PR addresses the issue but doesn't completely resolve it (ie the issue should remain open after your PR is merged), write "addresses #XXXX".
15
+
Known bugs and intended new features are tracked using [GitHub issues](https://github.com/processing/p5.js/issues). Issue [labels](./issue_labels.md) are used to sort issues into categories, such as those which are [suitable for beginners](https://github.com/processing/p5.js/labels/level%3Abeginner). If you'd like to start working on an existing issue, comment on the issue that you plan to work on it so other contributors know it's being handled and can offer help. Once you have completed your work on this issue, [submit a pull request (PR)](./preparing_a_pull_request.md) against the p5.js master branch. In the description field of the PR, include "resolves #XXXX" tagging the issue you are fixing. If the PR addresses the issue but doesn't completely resolve it (ie the issue should remain open after your PR is merged), write "addresses #XXXX".
16
16
17
17
If you discover a bug or have an idea for a new feature you'd like to add, begin by submitting an issue. Please do not simply submit a pull request containing the fix or new feature without making an issue first, we will probably not be able to accept it. Once you have gotten some feedback on the issue and a go ahead to address it, you can follow the process above to contribute the fix or feature.
18
18
@@ -24,16 +24,16 @@ We recognize all types of contributions. This project follows the [all-contribut
24
24
25
25
Aside from the code itself, you may also need to supply some combination of the following.
26
26
27
-
-[inline documentation](https://github.com/processing/p5.js/blob/master/developer_docs/inline_documentation.md) in the form of code comments, which explain the code both to other developers and to users. Many of these comments must conform to [JSDoc](https://usejsdoc.org) syntax and will be published on the p5.js website as part of the [online reference manual](https://p5js.org/reference/)
28
-
-[unit tests](https://github.com/processing/p5.js/tree/master/developer_docs#unit-tests), small pieces of code which are separate from the library and are used to verify its behavior
29
-
-[benchmarks](https://github.com/processing/p5.js/blob/master/developer_docs/benchmarking_p5.md) to test performance
27
+
-[inline documentation](./inline_documentation.md) in the form of code comments, which explain the code both to other developers and to users. Many of these comments must conform to [JSDoc](https://usejsdoc.org) syntax and will be published on the p5.js website as part of the [online reference manual](https://p5js.org/reference/)
28
+
-[unit tests](./unit_testing.md), small pieces of code which are separate from the library and are used to verify its behavior
29
+
-[benchmarks](./benchmarking_p5.md) to test performance
30
30
31
31
## Examples
32
32
33
33
The p5.js site includes [integrated examples](http://p5js.org/examples/). You can [add more](https://github.com/processing/p5.js-website/blob/master/contributor_docs/Adding_examples.md), and there is an issue which lists some [desired examples](https://github.com/processing/p5.js/issues/1954).
34
34
35
35
## ES6
36
-
p5.js has recently migrated to [ES6](https://en.wikipedia.org/wiki/ECMAScript#6th_Edition_-_ECMAScript_2015). To see how this transition could effect your contribution please visit [ES6 adoption](https://github.com/processing/p5.js/blob/master/developer_docs/es6-adoption.md).
36
+
p5.js has recently migrated to [ES6](https://en.wikipedia.org/wiki/ECMAScript#6th_Edition_-_ECMAScript_2015). To see how this transition could effect your contribution please visit [ES6 adoption](./es6-adoption.md).
Copy file name to clipboardExpand all lines: developer_docs/contributing_documentation.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -4,9 +4,9 @@ There are several ways to contribute to documentation:
4
4
5
5
## ✏️ Contribute to the reference
6
6
Read through the [reference](http://p5js.org/reference/), and look for typos, broken examples, confusing documentation. If it's a straightforward fix, go ahead and work on it! If it's a more involved question that requires discussion, create an [issue](https://github.com/processing/p5.js/issues/new).
7
-
* Here are instructions for [getting setup for the first time with the p5.js repo](https://github.com/processing/p5.js/tree/master/developer_docs).
7
+
* Here are instructions for [getting setup for the first time with the p5.js repo](./README.md).
8
8
* The reference is built from the inline documentation in the source code (found in the `src/` folder).
9
-
* Here is information on [how to update or add inline documentation and examples](https://github.com/processing/p5.js/blob/master/developer_docs/inline_documentation.md).
9
+
* Here is information on [how to update or add inline documentation and examples](./inline_documentation.md).
10
10
* If you find errors with the [spanish documentation](http://p5js.org/es), there are instructions to update this [here](https://github.com/processing/p5.js-website#internationalization-i18n-and-structure).
11
11
12
12
## ✨ Make examples
@@ -23,7 +23,7 @@ While the examples in the reference are meant to be very simplistic snippets of
23
23
24
24
## 👉 Getting started
25
25
* Read the [p5.js community statement](http://p5js.org/community/)
26
-
* Optional: Check out the [developer docs](https://github.com/processing/p5.js/tree/master/developer_docs) to get an overview of the repository and learn how to build the code (if relevant for you).
26
+
* Optional: Check out the [developer docs](./README.md) to get an overview of the repository and learn how to build the code (if relevant for you).
27
27
* All discussion happens on github issues, so there's no slack/gitter/etc channel you need to join.
28
28
* Add your name to the [contributors list](https://github.com/processing/p5.js#contributors) in the readme.md file! Instructions [here](https://github.com/processing/p5.js/issues/2309).
29
29
* And of course, if you're more of a bug fixer kind of person, feel free to jump into any of the [issues](https://github.com/processing/p5.js/issues)!
Joining in on the discussion about how p5 is developed is a great way to contribute. This can be done in a number of ways but one great place to start is by checking out the existing Github [issues that have been labeled 'discussion'](https://github.com/processing/p5.js/labels/discussion) and adding your voice.
2
+
3
+
The documents in this subsection are developed based on these discussion. This is where we compile ideas about current and future design for the library.
Help is needed translating these Developer Docs to Spanish (and other languages)
2
+
[See this link for more info!](https://github.com/processing/p5.js/issues/4137)
3
+
4
+
¡Hola! ¡Gracias por su interés en contribuir a p5.js! Puede comenzar con algunas formas diferentes de contribuir [aquí](https://p5js.org/community/#contribute). Esta carpeta contiene varios documentos destinados a desarrolladores de p5.js.
5
+
6
+
# Estructura del directorio del proyecto
7
+
8
+
-`src /` contiene todo el código fuente de la biblioteca, que está organizado por temas en módulos separados. Esto es en lo que trabajará si está cambiando p5.js.
9
+
-`lib /` contiene la versión final de p5.js destinada a que los usuarios carguen en sus bocetos y proyectos, incluidos en formularios comprimidos y no comprimidos. Esta es la salida cuando [Grunt](https://gruntjs.com/) compila los módulos de código fuente en un solo archivo.
10
+
-`developer_docs /` contiene varios documentos de Markdown que probablemente sean útiles para los desarrolladores de p5.js, en particular porque explican prácticas y principios.
11
+
-`docs /` en realidad no contiene documentos! Más bien, contiene el código utilizado para * generar * el [manual de referencia en línea](https://p5js.org/reference/).
12
+
-`tests /` contiene pruebas unitarias que aseguran que la biblioteca continúe funcionando correctamente a medida que se realizan los cambios.
13
+
-`task /` contiene scripts que realizan tareas automatizadas relacionadas con la compilación, implementación y lanzamiento de nuevas versiones de p5.js.
14
+
-`parches /` podría contener [parches Git](https://git-scm.com/docs/git-format-patch) de vez en cuando, pero en casi todos los casos puede ignorar por completo este directorio.
0 commit comments