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
+63-1Lines changed: 63 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,16 @@
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, you'll find what you need in this guide to p5.js stewardship. If you are not sure what to expect from stewards, or if you are 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](#stewardship)
11
+
-[Community Care](#community-care)
12
+
-[Areas](#areas)
13
+
-[Becoming a Steward](#becoming-a-steward)
14
+
-[Getting Started with Stewardship](#getting-started-with-stewardship)
10
15
-[Issues](#issues)
11
16
-[Bug report](#bug-report)
12
17
-[Feature request](#feature-request)
@@ -28,6 +33,63 @@ Whether you have just joined us as a steward, are a seasoned maintainer of p5.js
28
33
29
34
---
30
35
36
+
## Stewardship
37
+
38
+
### Community Care
39
+
40
+
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:
41
+
42
+
1. Welcoming new contributors to GitHub through **friendly comments** and helpful **code reviews**
43
+
2. Helping to **facilitate feature discussions** and resolve technical disagreements. For example, this means making connections to other past discussion, or offering input from prior relevant experience. Suggesting features or working on them is contribution, rather than stewardship.
44
+
3. Participating in releases of the p5.js software through **supporting** bug fixing and feature completion. For example, this means guiding other contributors and reviewing their PRs. Fixing bugs is contribution, rather than stewardship.
45
+
46
+
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.
47
+
48
+
Everyone is invited to help steward the community when they can! We are happy to see contributors welcome new contributors, review others' code, and provide API design feedback. There are also some concrete roles:
49
+
50
+
1. Contributors are able to make Issues, PRs, Comments, and Code Reviews.
51
+
2. Maintainers are also able to merge PRs and admin other parts of the codebase.
52
+
53
+
Stewards can also be contributors: they can make Issues and PRs as contributors, while they also take on responsibility, when they are stewarding a particular area, to comment on issues and do code reviews, especially when tagged by other contributors to help with discussion and review.
54
+
55
+
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.
56
+
57
+
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!
58
+
59
+
### Areas
60
+
61
+
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.
62
+
63
+
-**Accessibility**: This area specifically refers to digital and web accessibility, including, for example, screen reader support via API like `describe(..)` as well as accessibility support on the reference website
64
+
-**Core**: Refers to core p5.js API, including rendering and environment
65
+
-**DevOps**: Refers to build process, unit testing, and other aspects of the development experience
66
+
-**Documentation**: Includes both reference in the core codebase that is exposed on the website, the contributor docs, and other website content
67
+
- i18n (Internationalization / **Translation**): Includes reviewing translations, particularly for `es`, `hi`, `ko`, `zh`
68
+
-**Graphics**: Contains subareas of WebGL and [p5.strands](https://beta.p5js.org/tutorials/intro-to-p5-strands/)
69
+
-**Color**: Includes Color, ColorMode, accessibility improvements around color usage
70
+
-**Typography**: Refers to all topics on handling text and font
71
+
-**Math**: Includes both external Math API and internal performance improvements
72
+
-**Shapes**: Includes working with custom shapes in both 1.11.x and 2.x versions of p5.js
73
+
-**Maintainers**: This group can merge PRs
74
+
-**p5.sound.js**: The [new p5.sound.js](https://github.com/processing/p5.sound.js) add-on library
75
+
-**p5.js-website**: Non-content aspects of the [reference website](https://p5js.org/) - for example, its structure, automations, technical improvements and so on.
76
+
77
+
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!
78
+
79
+
### Becoming a Steward
80
+
81
+
There are two ways to become a steward:
82
+
83
+
1._Nomination_ by maintainers or other stewards, such as in conversation over Discord, Discourse, or GitHub.
84
+
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.
85
+
86
+
To remain a steward, you must contribute as a steward to at least 1 of the 2 most recent minor releases (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!
87
+
88
+
### Getting Started with Stewardship
89
+
90
+
1. Keep this guideline handy as a reference - how to help with new issues, bugs, and features. For example, the "Feature request" section includes tips on how to use the the p5.js [access statement](access.md) as a steward.
91
+
2. When helping to answer technical questions or review, try to apply the Processing Foundation [guideline on answering questions](https://discourse.processing.org/t/guidelines-answering-questions/2145) - these can be especially helpful for giving constructive technical feedback.
92
+
3. Join the [p5.js Discord](https://discord.com/invite/SHQ8dH25r9) - in the `#contribute-to-p5` you're welcome to ask any questions you have about this process - or suggest how it can be improved!
0 commit comments