Skip to content

Commit cbfce12

Browse files
authored
Update steward_guidelines.md
1 parent 7b80ec5 commit cbfce12

File tree

1 file changed

+17
-19
lines changed

1 file changed

+17
-19
lines changed

contributor_docs/steward_guidelines.md

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Whether you are new to p5.js contribution, are already active on the p5.js GitHu
77

88
## Table of Contents
99

10-
- [Stewardship]
10+
- [Stewardship](#stewardship)
1111
- [Community Care](#community-care)
1212
- [Areas](#areas)
1313
- [Becoming a Steward](#becoming-a-steward)
@@ -59,32 +59,30 @@ As a steward, we hope that you regularly chime in on code reviews on Issues or P
5959

6060
There are different areas of work that stewards can be responsible for. These areas match the GitHub Labels in most cases, with a couple of exceptions. Below is the list of areas.
6161

62-
- Accessibility: This area specifically refers to digital and web accessibility, including, for example, screen reader suport via API like `describe(..)` as well as accessibility support on the reference website
63-
- Core: Refers to core p5.js API, including rendering and environment
64-
- DevOps: Refers to build process, unit testing,
65-
- Documentation: includes both reference in the core codebase that is exposed on the website, the contributor docs, and other website content
66-
- i18n (Internationalization): Includes writing and reviewing translations, specifically for the supported languages on the reference website (`es`, `hi`, `ko`, `zh`)
67-
- Graphics: Contains subareas of WebGL and [p5.strands](https://beta.p5js.org/tutorials/intro-to-p5-strands/)
68-
- Color: Includes Color, ColorMode, accessibility improvements around color usage, colro in 2D and 3D, and so on
69-
- Typography: Refers to all topics on handling text and font
70-
- Math: Includes both external Math API and internal performance improvements
71-
- Shapes: Includes working with custom shapes in both 1.11.x and 2.x versions of p5.js
72-
- Maintainers: this is not an area, but rather the group of contributors who have the ability to merge PRs
73-
- p5.sound.js: The [new p5.sound.js](https://github.com/processing/p5.sound.js) addon library
74-
- p5.js-website: Non-content aspects of the [reference website](https://p5js.org/) - for example, its structure, automations, technical improvements and so on.
62+
- **Accessibility**: This area specifically refers to digital and web accessibility, including, for example, screen reader suport via API like `describe(..)` as well as accessibility support on the reference website
63+
- **Core**: Refers to core p5.js API, including rendering and environment
64+
- **DevOps**: Refers to build process, unit testing,
65+
- **Documentation**: includes both reference in the core codebase that is exposed on the website, the contributor docs, and other website content
66+
- i18n (Internationalization / **Translation**): Includes writing and reviewing translations, particularly for `es`, `hi`, `ko`, `zh`
67+
- **Graphics**: Contains subareas of WebGL and [p5.strands](https://beta.p5js.org/tutorials/intro-to-p5-strands/)
68+
- **Color**: Includes Color, ColorMode, accessibility improvements around color usage, colro in 2D and 3D, and so on
69+
- **Typography**: Refers to all topics on handling text and font
70+
- **Math**: Includes both external Math API and internal performance improvements
71+
- **Shapes**: Includes working with custom shapes in both 1.11.x and 2.x versions of p5.js
72+
- **Maintainers**: This group can merge PRs
73+
- **p5.sound.js**: The [new p5.sound.js](https://github.com/processing/p5.sound.js) addon library
74+
- **p5.js-website**: Non-content aspects of the [reference website](https://p5js.org/) - for example, its structure, automations, technical improvements and so on.
7575

7676
These focus areas may change over time depending on the needs of the project - so if you are going through the process of applying to be a steward, you are welcome to proposals new areas!
7777

7878
### Becoming a Steward
7979

8080
There are two ways to become a steward:
8181

82-
1. Nomination by maintainers or other stewards - this can happen in conversation over Discord or GitHub, and a maintainer may reach out to you
83-
2. Application by creating a PR to update `stewards.yml` with your GitHub @ and proposed areas. Please keep in mind each area should have 1-3 stewards. We are always looking for **translation stewards**! Once you make your application PR, other maintainers or stewards may ask for additional supporting material, like making a PR related to the areas you're interested in, or participating in some related discussion.
82+
1. _Nomination_ by maintainers or other stewards, such as in conversation over Discord, Discourse, or GitHub.
83+
2. _Application_ by creating a PR to update `stewards.yml` with your GitHub @ and proposed areas. Please keep in mind each area should have 1-3 stewards. We are always looking for **translation stewards**! Once you make your application PR, other maintainers or stewards may ask for additional supporting material, like making a PR related to the areas you're interested in, or participating in some related discussion.
8484

85-
To remain a steward, you must contribute as a steward to at least 1 of the 2 most recent minor (e.g., 2.1.0 or 1.11.0 - when the middle number changes) or major releases (e.g., 2.0 - when the leftmsot number changes). This means supporting other contributors through discussion or code review.
86-
87-
To step down from stewardship, you can make a PR to remove yourself from `stewards.yml`. You are always welcome to take a pause and reapply in the future!
85+
To remain a steward, you must contribute as a steward to at least 1 of the 2 most recent minor (e.g., 2.1.0 or 1.11.0 - when the middle number changes). These are not as frequent as patches (e.g., 2.0.3 to 2.0.4 - when the rightmost number changes), and in practice this means that stewards are expected to be active every 4-6 months or so, supporting other contributors through discussion or code review - not necessarily writing code. To step down from stewardship, you can make a PR to remove yourself from `stewards.yml`. You are always welcome to take a pause and reapply in the future!
8886

8987
## Issues
9088

0 commit comments

Comments
 (0)