Skip to content

Commit f123ad4

Browse files
committed
Fixes in guideline and new stewards
1 parent 842e9c4 commit f123ad4

File tree

4 files changed

+70
-33
lines changed

4 files changed

+70
-33
lines changed

README.md

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -86,27 +86,29 @@ Lead/Mentor Alumni
8686
* [@qianqianye](https://github.com/qianqianye) - p5.js Lead,2021-present (on leave)
8787
* [@outofambit](https://github.com/outofambit) - p5.js Co-Lead 2021-22, Mentor 2022-2023
8888
* [@mcturner1995](https://github.com/mcturner1995) - p5.js Lead 2020
89-
90-
| Area | Steward(s) |
91-
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
92-
| Overall | [@ksen0](https://github.com/ksen0) |
93-
| [Accessibility](https://github.com/processing/p5.js/tree/main/src/accessibility) | [@calebfoss](https://github.com/calebfoss), [@cosmicbhejafry](https://github.com/cosmicbhejafry), [@apoorva-a98](https://github.com/apoorva-a98), [@tedkmburu](https://github.com/tedkmburu), [@Zarkv](https://github.com/Zarkv), [@SkylerW99](https://github.com/SkylerW99), [@itsjoopark](https://github.com/itsjoopark), [@hannahvy](https://github.com/hannahvy), [@nhasalajoshi](https://github.com/nhasalajoshi)|
94-
| [Color](https://github.com/processing/p5.js/tree/main/src/color) | [@paulaxisabel](https://github.com/paulaxisabel), [@SoundaryaKoutharapu](https://github.com/SoundaryaKoutharapu), [@mrbrack](https://github.com/mrbrack), [@TJ723](https://github.com/TJ723), [@Zarkv](https://github.com/Zarkv), [@SkylerW99](https://github.com/SkylerW99), [@ramya202000](https://github.com/ramya202000), [@hannahvy](https://github.com/hannahvy), [@robin-haxx](https://github.com/robin-haxx), [@hiddenenigma](https://github.com/hiddenenigma) |
95-
| [Core](https://github.com/processing/p5.js/tree/main/src/core)/Environment/Rendering | [@limzykenneth](https://github.com/limzykenneth), [@davepagurek](https://github.com/davepagurek), [@ChihYungChang](https://github.com/ChihYungChang), [@teragramgius](https://github.com/teragramgius), [@tuminzee](https://github.com/tuminzee), [@Zarkv](https://github.com/Zarkv), [@robin-haxx](https://github.com/robin-haxx), [@Gaurav-1306](https://github.com/Gaurav-1306) |
96-
| [Data](https://github.com/processing/p5.js/tree/main/src/data) | [@angelabelle](https://github.com/angelabelle), [@shahankhatch](https://github.com/shahankhatch), [@TanviKumar](https://github.com/TanviKumar), [@SkylerW99](https://github.com/SkylerW99), [@nhasalajoshi](https://github.com/nhasalajoshi) |
97-
| [DOM](https://github.com/processing/p5.js/tree/main/src/dom) | [@SarveshLimaye](https://github.com/SarveshLimaye), [@SoundaryaKoutharapu](https://github.com/SoundaryaKoutharapu), [@ramya202000](https://github.com/ramya202000), [@BamaCharanChhandogi](https://github.com/BamaCharanChhandogi), [@Obi-Engine10](https://github.com/Obi-Engine10), [@MarceloGoncalves](https://github.com/MarceloGoncalves), [@hiddenenigma](https://github.com/hiddenenigma) |
98-
| [Events](https://github.com/processing/p5.js/tree/main/src/events) | [@limzykenneth](https://github.com/limzykenneth), [@richardegil](https://github.com/richardegil), [@angelabelle](https://github.com/angelabelle), [@littlejacinthe](https://github.com/littlejacinthe), [@TanviKumar](https://github.com/TanviKumar), [@tuminzee](https://github.com/tuminzee) |
99-
| [Image](https://github.com/processing/p5.js/tree/main/src/image) | [@cgusb](https://github.com/cgusb), [@albertomancia](https://github.com/albertomancia), [@ramya202000](https://github.com/ramya202000), [@hannahvy](https://github.com/hannahvy), [@robin-haxx](https://github.com/robin-haxx)|
100-
| [IO](https://github.com/processing/p5.js/tree/main/src/io) | [@limzykenneth](https://github.com/limzykenneth), [@Pritam1136](https://github.com/Pritam1136), [@shahankhatch](https://github.com/shahankhatch), [@TanviKumar](https://github.com/TanviKumar), [@jeanetteandrews](https://github.com/jeanetteandrews)|
101-
| [Math](https://github.com/processing/p5.js/tree/main/src/math) | [@limzykenneth](https://github.com/limzykenneth), [@ericnlchen](https://github.com/ericnlchen), [@ChihYungChang](https://github.com/ChihYungChang), [@bsubbaraman](https://github.com/bsubbaraman), [@albertomancia](https://github.com/albertomancia), [@JazerUCSB](https://github.com/JazerUCSB), [@tedkmburu](https://github.com/tedkmburu), [@perminder-17](https://github.com/perminder-17), [@Obi-Engine10](https://github.com/Obi-Engine10), [@jeanetteandrews](https://github.com/jeanetteandrews) |
102-
| [Typography](https://github.com/processing/p5.js/tree/main/src/typography) | [@dhowe](https://github.com/dhowe), [@paulaxisabel](https://github.com/paulaxisabel), [@SarveshLimaye](https://github.com/SarveshLimaye), [@SkylerW99](https://github.com/SkylerW99), [@BamaCharanChhandogi](https://github.com/BamaCharanChhandogi), [@Obi-Engine10](https://github.com/Obi-Engine10), [@hannahvy](https://github.com/hannahvy), [@singshris](https://github.com/singshris), [@hiddenenigma](https://github.com/hiddenenigma) |
103-
| [Utilities](https://github.com/processing/p5.js/tree/main/src/utilities) | [@limzykenneth](https://github.com/limzykenneth), [@glopzel](https://github.com/glopzel) |
104-
| [WebGL](https://github.com/processing/p5.js/tree/main/src/webgl) | [@davepagurek](https://github.com/davepagurek), [@aferriss](https://github.com/aferriss), [@aceslowman](https://github.com/aceslowman), [@ShenpaiSharma](https://github.com/ShenpaiSharma), [@ChihYungChang](https://github.com/ChihYungChang), [@teragramgius](https://github.com/teragramgius), [@JazerUCSB](https://github.com/JazerUCSB), [@richardegil](https://github.com/richardegil), [@itsjoopark](https://github.com/itsjoopark), [@Gaurav-1306](https://github.com/Gaurav-1306), [@jeanetteandrews](https://github.com/jeanetteandrews) |
105-
| [Internalization](https://github.com/processing/p5.js/blob/main/src/core/internationalization.js) | [@limzykenneth](https://github.com/limzykenneth) |
106-
| [Friendly Errors](https://github.com/processing/p5.js/tree/main/src/core/friendly_errors) | [@richardegil](https://github.com/richardegil), [@itsjoopark](https://github.com/itsjoopark), [@hannahvy](https://github.com/hannahvy), [@bisabi-01](https://github.com/bisabi-01), [@singshris](https://github.com/singshris) |
107-
| [Contributor Docs](https://github.com/processing/p5.js/tree/main/contributor_docs) |[@limzykenneth](https://github.com/limzykenneth), [@asukaminato0721](https://github.com/asukaminato0721), [@SoundaryaKoutharapu](https://github.com/SoundaryaKoutharapu), [@richardegil](https://github.com/richardegil), [@hannahvy](https://github.com/hannahvy), [@bayomayo](https://github.com/bayomayo) |
108-
| [p5.sound](https://github.com/processing/p5.sound.js) |[@miguellacorte](https://github.com/miguellacorte), [@JazerUCSB](https://github.com/JazerUCSB), [@angelabelle](https://github.com/angelabelle), [@littlejacinthe](https://github.com/littlejacinthe), [@hannahvy](https://github.com/hannahvy), [@glopzel](https://github.com/glopzel), [@singshris](https://github.com/singshris), [@jeanetteandrews](https://github.com/jeanetteandrews) |
109-
| Build Process/Unit Testing | [@limzykenneth](https://github.com/limzykenneth) |
89+
90+
91+
<!-- STEWARDS-LIST:START - Do not remove or modify this section -->
92+
| Area | Steward(s) |
93+
|------|-------------|
94+
| Maintainers | [@davepagurek](https://github.com/davepagurek), [@ksen0](https://github.com/ksen0), [@limzykenneth](https://github.com/limzykenneth), [@perminder-17](https://github.com/perminder-17), [@qianqianye](https://github.com/qianqianye) |
95+
| Accessibility | [@calebfoss](https://github.com/calebfoss) |
96+
| Color | [@limzykenneth](https://github.com/limzykenneth) |
97+
| Core | [@davepagurek](https://github.com/davepagurek) |
98+
| DevOps | [@Vaivaswat2244](https://github.com/Vaivaswat2244), [@error-four-o-four](https://github.com/error-four-o-four), [@limzykenneth](https://github.com/limzykenneth), [@lirenjie95](https://github.com/lirenjie95) |
99+
| Documentation | [@VANSH3104](https://github.com/VANSH3104), [@limzykenneth](https://github.com/limzykenneth), [@perminder-17](https://github.com/perminder-17) |
100+
| Friendly Errors | [@IITM-Jay](https://github.com/IITM-Jay) |
101+
| Graphics (p5.strands) | [@lukeplowden](https://github.com/lukeplowden) |
102+
| Graphics (WebGL) | [@aferriss](https://github.com/aferriss), [@davepagurek](https://github.com/davepagurek), [@lukeplowden](https://github.com/lukeplowden), [@perminder-17](https://github.com/perminder-17) |
103+
| i18n (hi) | [@Divyansh013](https://github.com/Divyansh013), [@takshittt](https://github.com/takshittt) |
104+
| i18n (zh) | [@limzykenneth](https://github.com/limzykenneth), [@lirenjie95](https://github.com/lirenjie95) |
105+
| Math | [@GregStanton](https://github.com/GregStanton), [@holomorfo](https://github.com/holomorfo) |
106+
| p5.js-website | [@clairep94](https://github.com/clairep94), [@ksen0](https://github.com/ksen0) |
107+
| p5.sound.js | [@ogbabydiesal](https://github.com/ogbabydiesal) |
108+
| Shapes | [@GregStanton](https://github.com/GregStanton) |
109+
| Typography | [@dhowe](https://github.com/dhowe) |
110+
| WebGL | [@RandomGamingDev](https://github.com/RandomGamingDev) |
111+
<!-- STEWARDS-LIST:END -->
110112

111113
## Contributors
112114

contributor_docs/steward_guidelines.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# Steward Guidelines
44

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!
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!
66

77

88
## Table of Contents
@@ -44,7 +44,7 @@ An open source ethos includes [accessibility, education, collaboration, transpar
4444

4545
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.
4646

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:
47+
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:
4848

4949
1. Contributors are able to make Issues, PRs, Comments, and Code Reviews.
5050
2. Maintainers are also able to merge PRs and admin other parts of the codebase.
@@ -62,15 +62,15 @@ There are different areas of work that stewards can be responsible for. These ar
6262
- **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
6363
- **Core**: Refers to core p5.js API, including rendering and environment
6464
- **DevOps**: Refers to build process, unit testing, and other aspects of the development experience
65-
- **Documentation**: includes both reference in the core codebase that is exposed on the website, the contributor docs, and other website content
65+
- **Documentation**: Includes both reference in the core codebase that is exposed on the website, the contributor docs, and other website content
6666
- i18n (Internationalization / **Translation**): Includes reviewing translations, particularly for `es`, `hi`, `ko`, `zh`
6767
- **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
68+
- **Color**: Includes Color, ColorMode, accessibility improvements around color usage
6969
- **Typography**: Refers to all topics on handling text and font
7070
- **Math**: Includes both external Math API and internal performance improvements
7171
- **Shapes**: Includes working with custom shapes in both 1.11.x and 2.x versions of p5.js
7272
- **Maintainers**: This group can merge PRs
73-
- **p5.sound.js**: The [new p5.sound.js](https://github.com/processing/p5.sound.js) addon library
73+
- **p5.sound.js**: The [new p5.sound.js](https://github.com/processing/p5.sound.js) add-on library
7474
- **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!

stewards.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,3 +54,31 @@ GregStanton:
5454
holomorfo:
5555
- Math
5656

57+
lirenjie95:
58+
- i18n:
59+
- zh
60+
- DevOps
61+
62+
IITM-Jay:
63+
- Friendly Errors
64+
65+
Vaivaswat2244:
66+
- DevOps
67+
68+
RandomGamingDev:
69+
- WebGL
70+
71+
VANSH3104:
72+
- Documentation
73+
74+
error-four-o-four:
75+
- DevOps
76+
77+
takshittt:
78+
- i18n:
79+
- hi
80+
81+
clairep94:
82+
- p5.js-website
83+
84+

utils/stewards-table.js

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,27 +8,32 @@ const areaMap = {};
88
const maintainers = new Set();
99
const supportedi18n = new Set(['hi', 'ko', 'zh', 'es']);
1010

11+
1112
for (const [user, roles] of Object.entries(parsed)) {
1213
roles.forEach(role => {
1314
if (typeof role === 'string') {
1415
if (role.toLowerCase() === 'maintainers') {
1516
maintainers.add(user);
1617
}
1718
areaMap[role] = areaMap[role] || new Set();
18-
areaMap[role].add(`@${user}`);
19+
areaMap[role].add(`${user}`);
1920
} else {
2021
for (const [main, subs] of Object.entries(role)) {
2122
subs.forEach(sub => {
2223
if (main === 'i18n' && !supportedi18n.has(sub)) return;
2324
const key = `${main} (${sub})`;
2425
areaMap[key] = areaMap[key] || new Set();
25-
areaMap[key].add(`@${user}`);
26+
areaMap[key].add(`${user}`);
2627
});
2728
}
2829
}
2930
});
3031
}
3132

33+
34+
const startMarker = '<!-- STEWARDS-LIST:START - Do not remove or modify this section -->';
35+
const endMarker = '<!-- STEWARDS-LIST:END -->';
36+
3237
const header = '| Area | Steward(s) |';
3338
const divider = '|------|-------------|';
3439

@@ -41,13 +46,15 @@ const sortedEntries = Object.entries(areaMap).sort(([aKey], [bKey]) => {
4146
const rows = sortedEntries.map(([area, users]) => `| ${area} | ${[...users].sort().map(
4247
u => `[@${u}](https://github.com/${u})`
4348
).join(', ')} |`).join('\n');
44-
const newTable = [header, divider, rows].join('\n');
49+
const newTable = [startMarker, header, divider, rows, endMarker].join('\n');
4550

4651
let readme = fs.readFileSync('README.md', 'utf8');
4752

48-
readme = readme.replace(
49-
/\| *Area *\|.*\n\|[-| ]+\|\n(?:\|.*\|\n?)*/g,
50-
newTable + '\n'
51-
);
53+
const startIndex = readme.indexOf(startMarker);
54+
const endIndex = readme.indexOf(endMarker) + endMarker.length;
55+
56+
if (startIndex !== -1 && endIndex !== -1) {
57+
readme = readme.slice(0, startIndex) + newTable + readme.slice(endIndex);
58+
}
5259

5360
fs.writeFileSync('README.md', readme);

0 commit comments

Comments
 (0)