Skip to content

Commit 74ea19f

Browse files
committed
Pull updates from p5.js repo contributor_docs folder
1 parent abf556c commit 74ea19f

11 files changed

+443
-39
lines changed

src/content/contributor-docs/en/contributor_guidelines.mdx

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,6 @@ This is a relatively long and comprehensive document but we will try to signpost
3737
* [Source code](#source-code)
3838
* [Unit tests](#unit-tests)
3939
* [Inline documentation](#inline-documentation)
40-
* [Internationalization](https://github.com/processing/p5.js/blob/main/contributor_docs/contributor_guidelines.md#internationalization)
4140
* [Accessibility](#accessibility)
4241
* [Code standard](#code-standard)
4342
* [Software Design principles](#software-design-principles)
@@ -154,7 +153,7 @@ For feature enhancement proposals to be accepted they must be approved by at lea
154153

155154
This template should be used if you wish to propose a new feature to be added to p5.js. For example to add support for drawing native HTML `<table>` elements with a new `createTable` function. Some proposals may overlap with existing feature enhancement proposals, in these cases you should just choose whichever template you feel is most appropriate.
156155

157-
Accordingly, the template form fields are nearly identical to the field of the "Existing Feature Enhancement." As such please see the [previous section](#existing-feature-enchancement) for details about how to fill in each field.
156+
Accordingly, the template form fields are nearly identical to the field of the "Existing Feature Enhancement." As such please see the [previous section](#existing-feature-enhancement) for details about how to fill in each field.
158157

159158
For new feature request proposals to be accepted, they must be approved by at least 2 [area stewards or maintainers](https://github.com/processing/p5.js#stewards) before work can begin on a pull request. 
160159

@@ -190,7 +189,7 @@ Similarly, you should work at your own pace and be confident that there is no ha
190189

191190
## Quick Get Started For Developers
192191

193-
If you want to work/contribute to p5.js'🌸 codebase as a developer, either directly for improving p5.js or for improving its sub-projects like [Friendly Error Systems](.https://github.com/processing/p5.js/blob/main/contributor_docs/friendly_error_system/), you can follow the following steps:
192+
If you want to work/contribute to p5.js'🌸 codebase as a developer, either directly for improving p5.js or for improving its sub-projects like [Friendly Error Systems](../friendly_error_system/), you can follow the following steps:
194193

195194
1. [Create a fork of p5.js.](https://docs.github.com/en/get-started/quickstart/fork-a-repo)
196195
2. [Clone your created fork to your computer.](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository)
@@ -373,7 +372,7 @@ If you are going to work on unit tests, please see [here](../unit_testing/). Not
373372

374373
### Inline documentation
375374

376-
If you are going to work on the inline documentation, as known as p5.js reference, please see [here](../contributing_to_the_p5.js_reference/).
375+
If you are going to work on the inline documentation, as known as p5.js reference, please see [here](../contributing_to_the_p5js_reference/).
377376

378377
### Accessibility
379378

src/content/contributor-docs/en/creating_libraries.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -306,4 +306,4 @@ p5.prototype.myMethod = function(){
306306

307307
**Examples are great, too!** They show people what your library can do. Because this is all JavaScript, people can see them running online before they download anything.[ ](http://jsfiddle.net/) You can create a collection of examples on the p5.js web editor to showcase how your library works.
308308

309-
**Let us know!** Once your library is ready for distribution, send an email to [[email protected]](mailto:[email protected]) with a link and some info. We'll include it on the [libraries page](http://p5js.org/libraries/)! If you have created a library and would like to have it included on the [p5js.org/libraries](https://p5js.org/libraries) page, please fill in [this form](https://docs.google.com/forms/d/e/1FAIpQLSdWWb95cfvosaIFI7msA7XC5zOEVsNruaA5klN1jH95ESJVcw/viewform).
309+
**Submit your library!** Once your library is ready for distribution and you’d like it included on the [p5js.org/libraries](https://p5js.org/libraries) page, please submit a pull request on the p5.js website GitHub repository following [this intruction](.https://github.com/processing/p5.js-website/blob/main/docs/contributing_libraries/)!

src/content/contributor-docs/en/documentation_style_guide.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ We use YUIDoc to generate the p5.js API documentation. To generate the docs, nav
5858
$ npm run grunt yui:dev
5959
```
6060

61-
The output will appear in docs/reference. Refer to the [inline documentation guide](.https://github.com/processing/p5.js/blob/main/contributor_docs/contributing_to_the_p5.js_reference/) for more information.
61+
The output will appear in docs/reference. Refer to the [inline documentation guide](../contributing_to_the_p5js_reference/) for more information.
6262

6363
**[⬆ back to top](#table-of-contents)**
6464

src/content/contributor-docs/en/friendly_error_system.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ The FES is a part of the p5.js' [internationalization] effort. We generate all F
3939

4040
We welcome contributions from all around the world! 🌐
4141

42-
[internationalization]: https://github.com/processing/p5.js/blob/main/contributor_docs/internationalization.md
42+
[internationalization]: https://github.com/processing/p5.js/blob/main/contributor_docs/archive/internationalization.md
4343

4444
[i18next]: https://www.i18next.com/
4545

@@ -132,7 +132,7 @@ translator('fes.fileLoadError.image', { suggestion });
132132

133133
The [internationalization doc] has a step-by-step guide on adding and modifying translation files.
134134

135-
[internationalization doc]: https://github.com/processing/p5.js/blob/main/contributor_docs/internationalization.md
135+
[internationalization doc]: https://github.com/processing/p5.js/blob/main/contributor_docs/archive/internationalization.md
136136

137137
## Understanding How FES Works
138138

@@ -165,13 +165,13 @@ These functions are mainly responsible for catching errors and generating FES me
165165

166166
For full reference, please see our [Dev Notes].
167167

168-
[`_friendlyFileLoadError()`]: https://github.com/processing/p5.js/blob/main/contributor_docs/fes_contribution_guide.md#_friendlyerror
168+
[`_friendlyFileLoadError()`]: ./fes_contribution_guide.md#_friendlyerror
169169

170-
[`_validateParameters()`]: https://github.com/processing/p5.js/blob/main/contributor_docs/fes_contribution_guide.md#_validateparameters
170+
[`_validateParameters()`]: ./fes_contribution_guide.md#_validateparameters
171171

172-
[`_fesErrorMontitor()`]: https://github.com/processing/p5.js/blob/main/contributor_docs/fes_contribution_guide.md#feserrormonitor
172+
[`_fesErrorMontitor()`]: ./fes_contribution_guide.md#feserrormonitor
173173

174-
[Dev Notes]: https://github.com/processing/p5.js/blob/main/contributor_docs/fes_contribution_guide.md#-development-notes
174+
[Dev Notes]: ./fes_contribution_guide.md#-development-notes
175175

176176
#### FES Message Displayer
177177

src/content/contributor-docs/en/how-to-add-friendly-error-messages.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Before we begin, identify which one of the following cases describes your case b
3131

3232
### Step 1 – Double-check your inline documentation
3333

34-
First, ensure your method has [inline documentation](.https://github.com/processing/p5.js/blob/main/contributor_docs/contributing_to_the_p5.js_reference/) with the full list of your parameters.
34+
First, ensure your method has [inline documentation](../contributing_to_the_p5js_reference/) with the full list of your parameters.
3535

3636
For example, the `circle()` method has the following inline documentation that starts with a description of the method, followed by a parameter list, and then code for an example:
3737

@@ -274,7 +274,7 @@ The above parameter validation message will be shown in Korean if the browser is
274274
Please consider adding unit tests for your new FE messages to detect bugs early and to ensure your code is delivering intended messages to our users. Also, unit tests are a good way to make sure other contributor’s new code does not accidentally break or interfere with the functionality of your code. Here are a few good guides on unit testing:
275275

276276
* [Unit Testing and Test Driven Development](https://docs.google.com/document/d/1iw60L1abRJZDn1zUViO9A0j6Fco4yFoQ9LXIlEEroN8/edit?usp=sharing) by Andy Timmons
277-
* [Contributors Doc: Unit Testing](.https://github.com/processing/p5.js/blob/main/contributor_docs/unit_testing/)
277+
* [Contributors Doc: Unit Testing](../unit_testing/)
278278

279279
Example:
280280

@@ -301,4 +301,4 @@ Additionally, we are excited to share insights from our community through the FE
301301
* [21-22 FES Survey Report Comic](https://almchung.github.io/p5jsFESsurvey/)
302302
* [21-22 FES Survey Full Report](https://observablehq.com/@almchung/p5-fes-21-survey)
303303
304-
For more in-depth information about the design and technical aspects of FES, please refer to the [FES README document](.https://github.com/processing/p5.js/blob/main/contributor_docs/friendly_error_system/). This document provides detailed explanations and development notes, which are beneficial for those seeking a deeper understanding of FES.
304+
For more in-depth information about the design and technical aspects of FES, please refer to the [FES README document](../friendly_error_system/). This document provides detailed explanations and development notes, which are beneficial for those seeking a deeper understanding of FES.

src/content/contributor-docs/en/steward_guidelines.mdx

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -12,24 +12,24 @@ Whether you have just joined us as a steward, are a seasoned maintainer of p5.js
1212

1313
## Table of Contents
1414

15-
* [Issues](steward_guidelines.md#issues)
16-
* [Bug report](steward_guidelines.md#bug-report)
17-
* [Feature request](steward_guidelines.md#feature-request)
18-
* [Feature enhancement](steward_guidelines.md#feature-enhancement)
19-
* [Discussion](steward_guidelines.md#discussion)
20-
* [Pull Requests](steward_guidelines.md#pull-requests)
21-
* [Simple fix](steward_guidelines.md#simple-fix)
22-
* [Bug fix](steward_guidelines.md#bug-fix)
23-
* [New feature/feature enhancement](steward_guidelines.md#new-feature-feature-enhancement)
24-
* [Dependabot](steward_guidelines.md#dependabot)
25-
* [Build Process](steward_guidelines.md#build-process)
26-
* [Main build task](steward_guidelines.md#main-build-task)
27-
* [Miscellaneous tasks](steward_guidelines.md#miscellaneous-tasks)
28-
* [Release Process](steward_guidelines.md#release-process)
29-
* [Tips & Tricks](steward_guidelines.md#tips--tricks)
30-
* [Reply templates](steward_guidelines.md#reply-templates)
31-
* [GitHub CLI](steward_guidelines.md#github-cli)
32-
* [Managing notifications](steward_guidelines.md#managing-notifications)
15+
* [Issues](#issues)
16+
* [Bug report](#bug-report)
17+
* [Feature request](#feature-request)
18+
* [Feature enhancement](#feature-enhancement)
19+
* [Discussion](#discussion)
20+
* [Pull Requests](#pull-requests)
21+
* [Simple fix](#simple-fix)
22+
* [Bug fix](#bug-fix)
23+
* [New feature/feature enhancement](#new-feature-feature-enhancement)
24+
* [Dependabot](#dependabot)
25+
* [Build Process](#build-process)
26+
* [Main build task](#main-build-task)
27+
* [Miscellaneous tasks](#miscellaneous-tasks)
28+
* [Release Process](#release-process)
29+
* [Tips & Tricks](#tips--tricks)
30+
* [Reply templates](#reply-templates)
31+
* [GitHub CLI](#github-cli)
32+
* [Managing notifications](#managing-notifications)
3333

3434
***
3535

@@ -90,7 +90,7 @@ Feature request issues should use the "New Feature Request" issue template. The
9090

9191
Feature enhancement issues should use the "Existing Feature Enhancement" issue template. The process is very similar to new feature requests. The difference between a new feature request and feature enhancement can be blurry sometimes. Feature enhancement mainly deals with existing functions of p5.js while a new feature request could be requesting entirely new functions to be added.
9292

93-
1. Similar to new feature requests, feature enhancement should only be accepted if they increase access to p5.js. Please see point 1 of [section above](steward_guidelines.md#feature-request).
93+
1. Similar to new feature requests, feature enhancement should only be accepted if they increase access to p5.js. Please see point 1 of [section above](#feature-request).
9494
2. Inclusion criteria for feature enhancements are similar to those for feature requests, but particular attention should be paid to potential breaking changes.
9595
* If modifying existing functions, all previous valid and documented function signatures must behave in the same way.
9696
3. Feature enhancements must be approved by at least one steward or maintainer before work should begin toward a PR. The PR review process for feature enhancement is documented below.
@@ -110,7 +110,7 @@ This type of issue has a minimal template ("Discussion") and should be used to g
110110
Almost all code contributions to the p5.js repositories happen through pull requests. Stewards and maintainers may have push access to the repositories but are still encouraged to follow the same issue > PR > review process when contributing code. Here are the steps to review a PR:
111111

112112
* Pull request template can be found [here](.https://github.com/processing/p5.js/blob/main/.github/PULL_REQUEST_TEMPLATE/).
113-
* Almost all pull requests must have associated issues opened and discussed first, meaning the relevant [issue workflow](steward_guidelines.md#issues) must have been followed first before a PR should be reviewed by any steward or maintainer.
113+
* Almost all pull requests must have associated issues opened and discussed first, meaning the relevant [issue workflow](#issues) must have been followed first before a PR should be reviewed by any steward or maintainer.
114114
* The only instances where this does not apply are very minor typo fixes, which do not require an open issue and can be merged by anyone with merge access to the repo, even if they are not stewards of a particular area.
115115
* While this exception exists, we will apply it in practice only while contributors are still encouraged to open new issues first. In other words, if in doubt about whether this exception applies, just open an issue anyway.
116116
* If a pull request does not fully solve the referenced issue, you can edit the original post and change "Resolves #OOOO" to "Addresses #OOOO" so that it does not automatically close the original issue when the PR is merged.
@@ -129,7 +129,7 @@ Simple fixes, such as a small typo fix, can be merged directly by anyone with me
129129

130130
2. The PR "Files Changed" tab can be used to initially review whether the fix is implemented as described in the issue discussion.
131131

132-
3. The PR should be tested locally whenever possible and relevant. The GitHub CLI can help streamline some of the process. (See more below in [Tips & Tricks](steward_guidelines.md#tips-tricks)).
132+
3. The PR should be tested locally whenever possible and relevant. The GitHub CLI can help streamline some of the process. (See more below in [Tips & Tricks](#tips-tricks)).
133133
* [ ] The fix should address the original issue sufficiently.
134134
* [ ] The fix should not change any existing behaviors unless agreed upon in the original issue.
135135
* [ ] The fix should not have a significant performance impact on p5.js.
@@ -322,13 +322,13 @@ Below are some of the Saved Replies that are being used by p5.js maintainers. Yo
322322
323323
##### Closing: Access
324324

325-
> I'm not seeing a lot of interest in this feature, and we don't have a clear explanation of how it [expands access](.access/), so I will close this for now. If an access statement can be added to the issue request, please feel welcome to reopen.
325+
> I'm not seeing a lot of interest in this feature, and we don't have a clear explanation of how it [expands access](../access/), so I will close this for now. If an access statement can be added to the issue request, please feel welcome to reopen.
326326
327-
> We do not see a further explanation of how this issue [expands access](.access/), so I will close this issue for now. If a more detailed access statement can be added to the feature request, please feel welcome to reopen it. Thank you!
327+
> We do not see a further explanation of how this issue [expands access](../access/), so I will close this issue for now. If a more detailed access statement can be added to the feature request, please feel welcome to reopen it. Thank you!
328328
329329
##### Closing: Addon
330330

331-
> I think this function is beyond the scope of the p5.js API (we try to keep it as minimal as possible), but it could be a great starting point for an addon library. See the docs here for how to create an addon: [https://github.com/processing/p5.js/blob/main/contributor\_docs/creating\_libraries.md](.creating_libraries/)
331+
> I think this function is beyond the scope of the p5.js API (we try to keep it as minimal as possible), but it could be a great starting point for an addon library. See the docs here for how to create an addon: [Creating an Addon Library](../creating_libraries/)
332332
333333
##### Closing PR: Need Issue First
334334

0 commit comments

Comments
 (0)