processing · Qianqianye · Mar 23, 2024 · Mar 15, 2024 · Mar 20, 2024 · Mar 22, 2024
diff --git a/contributor_docs/access.md b/contributor_docs/access.md
@@ -1,3 +1,5 @@
+<!-- What our commitment to access means for contributors and users of the library. -->
+
 # Our Focus on Access
 
 At the [2019 Contributors Conference](https://p5js.org/community/contributors-conference-2019.html), p5.js made the commitment to only add new features that increase access (inclusion and accessibility). We will not accept feature requests that don't support these efforts. We commit to the work of acknowledging, dismantling, and preventing barriers. This means considering intersecting[^1] experiences of diversity that can impact access and participation. These include alignments of gender, race, ethnicity, sexuality, language, location, et cetera. We center the needs of marginalized groups over the continued comfort of those privileged within the p5.js community. We are collectively exploring the meaning of access. We are learning how to practice and teach access. We choose to think of access through expansive, intersectional, and coalitionary frameworks. This commitment is part of the core values of p5.js outlined in our [Community Statement](https://p5js.org/community/).

diff --git a/contributor_docs/archive/custom_p5_build.md b/contributor_docs/archive/custom_p5_build.md
@@ -1,3 +1,5 @@
+<!-- Instructions on how to combine just the p5.js modules you need into a single file. -->
+
 # Creating a custom build of p5.js with select components
 
 ## Overview

diff --git a/contributor_docs/archive/internationalization.md b/contributor_docs/archive/internationalization.md
@@ -1,3 +1,5 @@
+<!-- How we integrate translations into the p5.js codebase. -->
+
 # 🌐 Internationalization
 
 [Internationalization](https://developer.mozilla.org/docs/Glossary/Internationalization_and_localization) (sometimes abbreviated "i18n") refers to supporting multiple languages in a software project. This often means maintaining translations of text strings used in the project and letting users choose which translation they receive (or detecting it from their browser settings).

diff --git a/contributor_docs/archive/issue_labels.md b/contributor_docs/archive/issue_labels.md
@@ -1,3 +1,5 @@
+<!-- A field guide to organizing p5.js GitHub issues. -->
+
 # p5.js issue labels
 
 p5.js uses a set of labels to help sort and organize issues.

diff --git a/contributor_docs/archive/supported_browsers.md b/contributor_docs/archive/supported_browsers.md
@@ -1,3 +1,5 @@
+<!-- How we decide what to support. -->
+
 # Supported browsers
 
 ## Our stated goal

diff --git a/contributor_docs/contributing_to_the_p5.js_reference.md b/contributor_docs/contributing_to_the_p5.js_reference.md
@@ -1,3 +1,5 @@
+<!-- A tour of the source code powering the Reference section of the p5.js website, and a guide to help contribute to it. -->
+
 # Contributing to the p5.js Reference
 
 In p5.js, we author the code reference you see on the [reference](https://p5js.org/reference/) page on the p5.js website by including them alongside the library’s source code as specialized comments. These reference comments include the description, the function’s signature (its parameters and return value), and usage examples. In other words, the content on each p5.js function/variable’s reference page is built from the reference comments in the source code.

diff --git a/contributor_docs/contributor_guidelines.md b/contributor_docs/contributor_guidelines.md
@@ -1,3 +1,5 @@
+<!-- Start here if you are looking to participate on GitHub! -->
+
 # Contributor Guidelines
 
 Welcome to the contributor guidelines! This document is for new contributors looking to contribute code to p5.js, contributors looking to refresh their memories on some technical steps, or just about anything else to do with code contributions to p5.js.
@@ -455,11 +457,11 @@ git push -u origin [branch_name]
 
 Once the push is complete, you may see a link in the terminal that lets you open a pull request, if not you can navigate to your fork in your web browser, switch to the branch you are working on with the dropdown button on top of the file list, click on "Contribute" then "Open pull request."
 
-![](https://lh7-us.googleusercontent.com/xoqM9gLSFXyw7b3gzG8JlHqoO0zxHALbjSz93E3D0HNh4Jw2wDWdzHKUEchnB6hdjQC7hVn-o5prrXkLw2WiEOoVKJF6kpmyA65sirN0z-Vy3PBY3rCXC5Ifn5stQhcdUQxQS0rsVoW0_hlkfTcY8PQ)
+![Screenshot of the git command line response after pushing a new branch. It includes a GitHub link to open a new pull request.](images/new-branch.png)
 
 You may also see a button to open a pull request when you visit the p5.js Github repo. Clicking it will also work to open a new pull request.
 
-![Cropped screenshot of the main page of the p5.js GitHub repository web page. A section near the top of the page is a yellow call to action box containing a green button with the text "Compare & pull request".](images/recent-pushes)
+![Cropped screenshot of the main page of the p5.js GitHub repository web page. A section near the top of the page is a yellow call to action box containing a green button with the text "Compare & pull request".](images/recent-pushes.png)
 
 
 ### Pull request information

diff --git a/contributor_docs/creating_libraries.md b/contributor_docs/creating_libraries.md
@@ -1,3 +1,5 @@
+<!-- Step-by-step instructions on how to create an addon library. -->
+
 # Creating an Addon Library
 
 A p5.js addon library is JavaScript code that extends or adds to the p5.js core functionality. While p5.js itself already provides a wide range of functionality, it doesn’t aim to cover everything you can do with JavaScript and the Web API. Addon libraries let you extend p5.js without needing to incorporate the features into p5.js. This guide will take you through the steps of creating an addon library that loads a simple CSV file by implementing a `loadCSV()` function.

diff --git a/contributor_docs/documentation_style_guide.md b/contributor_docs/documentation_style_guide.md
@@ -1,3 +1,5 @@
+<!-- A reference to help give our documentation a consistent voice. -->
+
 # Documentation Style Guide
 
 Hello! Welcome to the guidelines for writing p5.js documentation. This document is a remix of the following resources:

diff --git a/contributor_docs/fes_contribution_guide.md b/contributor_docs/fes_contribution_guide.md
@@ -1,3 +1,5 @@
+<!-- An overview of the Friendly Error System codebase and a reference for developers. -->
+
 # Friendly Errors System Contribution Guide
 
 The `core/friendly_errors` folder contains the code for the p5js’ Friendly Error Systems (FES) responsible for generating Friendly Error messages or Friendly Errors. You may have seen Friendly Error messages starting with “`🌸 p5.js says:`” in your console, supplementing default, browser-generated error messages.

diff --git a/contributor_docs/friendly_error_system.md b/contributor_docs/friendly_error_system.md
@@ -1,3 +1,5 @@
+<!-- An overview of the system used by p5.js to provide errors in friendly language. -->
+
 # 🌸 p5.js Friendly Error System (FES)
 
 ## Overview

diff --git a/contributor_docs/images/new-branch.png b/contributor_docs/images/new-branch.png
diff --git a/contributor_docs/release_process.md b/contributor_docs/release_process.md
@@ -1,3 +1,5 @@
+<!-- How all the updates on GitHub get turned into a new version of the library. -->
+
 # Release process
 
 ## Approach

diff --git a/contributor_docs/steward_guidelines.md b/contributor_docs/steward_guidelines.md
@@ -1,3 +1,5 @@
+<!-- What to expect as a steward, and a playbook for common situations. -->
+
 # Steward Guidelines
 
 Whether you have just joined us as a steward, are a seasoned maintainer of p5.js, or are somewhere in between, this guide contains information as well as tips and tricks that will help you effectively contribute to p5.js. Most of what is written here are guidelines unless otherwise stated, which means you can adapt the practices shown here to suit your workflow.

diff --git a/contributor_docs/unit_testing.md b/contributor_docs/unit_testing.md
@@ -1,3 +1,5 @@
+<!-- Learn how to write tests for p5.js, and help us keep the library bug-free.  -->
+
 # Unit Testing
 
 Unit testing is an essential part of how a large codebase can stay relatively bug-free. Unit tests are small pieces of code that aim to test individual components of a larger code base for correctness. For example, making sure a function is doing what it should be doing or a class is creating its object instances correctly.

diff --git a/contributor_docs/web_accessibility.md b/contributor_docs/web_accessibility.md
@@ -1,3 +1,5 @@
+<!-- The features p5.js provides to help keep sketches accessible to everyone. -->
+
 # p5.js Web Accessibility
 
 This document describes the structure of p5.js’ web accessibility features for contributors.

diff --git a/contributor_docs/webgl_contribution_guide.md b/contributor_docs/webgl_contribution_guide.md
@@ -1,3 +1,5 @@
+<!-- How to get started working on the p5.js WebGL mode source code. -->
+
 # WebGL Contribution Guide
 
 If you're reading this page, you're probably interested in helping work on WebGL mode. Thank you, we're grateful for your help! This page exists to help explain how we structure WebGL contributions and to offer some tips for making changes.

diff --git a/contributor_docs/webgl_mode_architecture.md b/contributor_docs/webgl_mode_architecture.md
@@ -1,3 +1,5 @@
+<!-- An overview of the design decisions that make up WebGL mode and their motivation. -->
+
 # p5.js WebGL Mode Architecture
 
 This document is intended for contributors and library makers who want to extend the WebGL codebase. If you are looking for help using WebGL mode in your sketches, consider reading the WebGL tutorials [on the p5.js Learn page](https://p5js.org/learn/) instead.