node
node copied to clipboard
nodejs
doc: add option to have support me link
I volunteered in the last TSC meeting to create this to start broader input from collaborators.
@ruyadorno I'm not sure if htis addresses your concerns. @jasnell it tries to cover some of the points that you and others had raised about limitations on where links go.
It's a known issue that before any support me links are added some tooling would need to be updated to support the new format of the REAMDE.md
Adding https://github.com/nodejs/node/labels/blocked as I don't think this should land until all the README parsers we're using have been updated (and we should probably define what the format should be first).
we should probably define what the format should be first
What format do you have in mind? Examples:
| Handle | Name | Pronouns | Support | |
|---|---|---|---|---|
@Octocat |
Jane Doe | [email protected] | She/Her | https://example.com |
@Octocat - Jane Doe <[email protected]> (She/Her) Support Me
@RedYetiDev, @aduh95 I think this does define the format which would be
mhdawson - Michael Dawson <[email protected]> (he/him) Support me
based on what's written and the existing format listing people on the README.md
@aduh95 when you say all of the readme parsers do you have a list of what you had in mind?
I checked ncu-core-utils and added the extra Support me to section at the end of a number of collaborators in https://github.com/mhdawson/node-core-utils/blob/main/test/fixtures/README/README.md and all of the tests still passed so I think the regex in https://github.com/mhdawson/node-core-utils/blob/main/lib/collaborators.js is happy to have whatever after the initial parts that it matches with/uses.
Note that we have sections other than the collaborators section in the README that may repeat the same name. I suppose we want people to put the link in the collaborators section?
I suppose we want people to put the link in the collaborators section?
@joyeecheung I was thinking they could go into any of the sections related to collaborators, include TSC, Collaborators, the emeritus for each of those, etc. How about I add this list of places its ok to add to:
Collaborators Emeriti TSC voting members TSC regular members TSC emeriti members
?
I think it would be better to just use the collaborators section since everyone is in there equally, or people don’t need to copy paste the link into multiple sections. But I don’t very feel strongly about it.
@joyeecheung I'd be ok with either as well. I'll just update to say that and we can see if anybody else feels strongly otherwise.
@aduh95 just checking in again to see if you had a specific list of tooling we need to check as I think node-core-utils might be ok as per my comment in - https://github.com/nodejs/node/pull/53312#issuecomment-2179481119
There's also scripts in this repo (lint-readme-lists.mjs, and find-inactive-collaborators.mjs). If we were to allow the TSC list to change format, there would be more, but for collaborators, I think it's only those two.
@aduh95 I made this change to the README.md
diff --git a/README.md b/README.md
index 8e1ddf8531..40bab1099f 100644
--- a/README.md
+++ b/README.md
@@ -400,7 +400,7 @@ For information about the governance of the Node.js project, see
* [Mesteery](https://github.com/Mesteery) -
**Mestery** <<[email protected]>> (he/him)
* [mhdawson](https://github.com/mhdawson) -
- **Michael Dawson** <<[email protected]>> (he/him)
+ **Michael Dawson** <<[email protected]>> (he/him) [Support me](http://devrus.com)
* [mildsunrise](https://github.com/mildsunrise) -
**Alba Mendez** <<[email protected]>> (she/her)
* [MoLow](https://github.com/MoLow) -
root@18add8f89985:/newpull/io.js#
and then ran both of those scripts:
root@18add8f89985:/newpull/io.js# ./node ./tools/find-inactive-collaborators.mjs
Inactive collaborators:
* Mestery
* Khaidi Chu
root@18add8f89985:/newpull/io.js# ./node ./tools/lint-readme-lists.mjs
root@18add8f89985:/newpull/io.js#
And they seemed ok.
Anything else you can think I should check out before landing this PR?
Commit Queue failed
- Loading data for nodejs/node/pull/53312 ✔ Done loading data for nodejs/node/pull/53312 ----------------------------------- PR info ------------------------------------ Title doc: add option to have support me link (#53312) Author Michael Dawson <[email protected]> (@mhdawson) Branch mhdawson:sponsorship -> nodejs:main Labels doc, author ready, commit-queue-squash Commits 9 - doc: add option to have support me link - Update doc/contributing/reconizing-contributors.md - Update doc/contributing/reconizing-contributors.md - Update reconizing-contributors.md - Update reconizing-contributors.md - Update doc/contributing/reconizing-contributors.md - Update reconizing-contributors.md - Update doc/contributing/reconizing-contributors.md - Update doc/contributing/reconizing-contributors.md Committers 2 - Michael Dawson <[email protected]> - GitHub <[email protected]> PR-URL: https://github.com/nodejs/node/pull/53312 Refs: https://github.com/nodejs/TSC/issues/1552 Reviewed-By: Yagiz Nizipli <[email protected]> Reviewed-By: Moshe Atlow <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Ruy Adorno <[email protected]> Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> ------------------------------ Generated metadata ------------------------------ PR-URL: https://github.com/nodejs/node/pull/53312 Refs: https://github.com/nodejs/TSC/issues/1552 Reviewed-By: Yagiz Nizipli <[email protected]> Reviewed-By: Moshe Atlow <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Ruy Adorno <[email protected]> Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> -------------------------------------------------------------------------------- ⚠ Commits were pushed since the last approving review: ⚠ - Update doc/contributing/reconizing-contributors.md ⚠ - Update doc/contributing/reconizing-contributors.md ℹ This PR was created on Mon, 03 Jun 2024 20:11:17 GMT ✔ Approvals: 6 ✔ - Yagiz Nizipli (@anonrig): https://github.com/nodejs/node/pull/53312#pullrequestreview-2103276884 ✔ - Moshe Atlow (@MoLow) (TSC): https://github.com/nodejs/node/pull/53312#pullrequestreview-2094865955 ✔ - James M Snell (@jasnell) (TSC): https://github.com/nodejs/node/pull/53312#pullrequestreview-2094951781 ✔ - Ruy Adorno (@ruyadorno) (TSC): https://github.com/nodejs/node/pull/53312#pullrequestreview-2097049849 ✔ - Rafael Gonzaga (@RafaelGSS) (TSC): https://github.com/nodejs/node/pull/53312#pullrequestreview-2105411539 ✔ - Antoine du Hamel (@aduh95) (TSC): https://github.com/nodejs/node/pull/53312#pullrequestreview-2161154833 ✔ Last GitHub CI successful ℹ Green GitHub CI is sufficient -------------------------------------------------------------------------------- ✔ Aborted `git node land` session in /home/runner/work/node/node/.ncuhttps://github.com/nodejs/node/actions/runs/9861485696