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: contributor_docs/steward_guidelines.md
+58-1Lines changed: 58 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,15 @@
2
2
3
3
# Steward Guidelines
4
4
5
-
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.
5
+
Whether you are new to p5.js contribution, are already active on the p5.js GitHub repositories, or are somewhere in between, this guide contains information about p5.js stewardship. If you are not sure what to expect from stewards, or if you considering how to volunteer or get started as a steward, read on!
6
6
7
7
8
8
## Table of Contents
9
9
10
+
-[Stewardship]
11
+
-[Community Care](#community-care)
12
+
-[Areas](#areas)
13
+
-[Becoming a Steward](#becoming-a-steward)
10
14
-[Issues](#issues)
11
15
-[Bug report](#bug-report)
12
16
-[Feature request](#feature-request)
@@ -28,6 +32,59 @@ Whether you have just joined us as a steward, are a seasoned maintainer of p5.js
28
32
29
33
---
30
34
35
+
## Stewardship
36
+
37
+
### Community Care
38
+
39
+
An open source ethos includes [accessibility, education, collaboration, transparency, and agency](https://www.opensourceethos.net/). To live and practice these values while we write code together needs a lot of community care. These are the community care practices that are part of our definition of stewardship:
40
+
41
+
1. Welcoming new contributors to GitHub through **friendly comments** and helpful **code reviews**
42
+
2. Helping to **facilitate feature discussions** and resolve technical disagreements
43
+
3. Suporting **releases** of the p5.js software through bug reporting, bug fixing, feature completion
44
+
45
+
The rest of these guidelines provide some tips and tricks that will help you effectively contribute to p5.js, and to helpfully guide others' contributions. Most of what is written here are guidelines unless otherwise stated, which means you can adapt the practices shown here to suit your workflow.
46
+
47
+
Everyone is invited to help steward the community when you can! We are happy to see contributors welcome new contributors, review others' code, and provide API design feedback. There are also some concrete roles:
48
+
49
+
1. Contributors are able to make Issues, PRs, Comments, and Code Reviews.
50
+
2. Maintainers are also able to merge PRs and admin other parts of the codebase.
51
+
52
+
Stewards sit in-between: they can make Issues, PRs, Comments, and Code Reviews, but when they are stewarding a particular area, they can also be tagged by other contributors to help with discussion and review.
53
+
54
+
As a contributor, you can check the current stewards in the p5.js repository's README file and tag relevant stewards - but please be mindful of our contributor guidelines, which emphasize patience and mindfulness that most of the technical work on an open-source project is volunteer.
55
+
56
+
As a steward, we hope that you regularly chime in on code reviews on Issues or PRs that you did not make, if they are in your area and if you are able to provide helpful guidance!
57
+
58
+
### Areas
59
+
60
+
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.
61
+
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.
75
+
76
+
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!
77
+
78
+
### Becoming a Steward
79
+
80
+
There are two ways to become a steward:
81
+
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.
84
+
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!
0 commit comments