Skip to content

Commit 64dc84e

Browse files
authored
doc: update contributing & collaborator guide to point to website repo (#364)
Signed-off-by: flakey5 <[email protected]>
1 parent db5d284 commit 64dc84e

File tree

3 files changed

+16
-30
lines changed

3 files changed

+16
-30
lines changed

COLLABORATOR_GUIDE.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,15 @@
1212
- [Remarks on Technologies Used](#remarks-on-technologies-used)
1313
- [Additional Clarification](#additional-clarification)
1414

15-
This document contains information for Collaborators of the Node.js release worker project regarding maintaining code, documentation, and issues.
15+
This document contains information for Collaborators of the Node.js Release Worker project regarding maintaining code, documentation, and issues.
1616

1717
Collaborators should be familiar with the guidelines for new contributors in [CONTRIBUTING.md](./CONTRIBUTING.md)
1818

1919
## Issues and Pull Requests
2020

2121
Courtesy should always be shown to individuals submitting issues and pull requests to the Node.js Release Worker project.
2222

23-
Collaborators should feel free to take full responsibility for managing issues and pull requests they feel qualified to handle, as long as this is done while being mindful of these guidelines, the opinions of other Collaborators and guidance of the Web Infrastructure Group.
23+
Collaborators should feel free to take full responsibility for managing issues and pull requests they feel qualified to handle, as long as this is done while being mindful of these guidelines, the opinions of other Collaborators, and guidance of the Web Infrastructure Group.
2424

2525
Collaborators may close any issue or pull request they believe is not relevant to the future of the Node.js project. Where this is unclear, the issue should be left open for several days for additional discussion. Where this does not yield input from Node.js Collaborators or additional evidence that the issue has relevance, then the issue may be closed. Remember that issues can always be re-opened if necessary.
2626

@@ -43,7 +43,7 @@ We recommend collaborators follow the guidelines on the [Contributing Guide](./C
4343
Collaborators may opt to elevate pull requests or issues to the group for discussion by mentioning @nodejs/web-infra. This should be done where a pull request:
4444

4545
- Has a significant impact on the codebase
46-
- Is inherently controlversial; or
46+
- Is inherently controversial; or
4747
- Has failed to reach a consensus amongst the Collaborators who are actively participating in the discussion.
4848

4949
The Web Infrastructure should be the final arbiter where needed.
@@ -99,7 +99,7 @@ We chose [Cloudflare Workers](https://workers.cloudflare.com) because it is most
9999

100100
Cloudflare has also graciously provided the OpenJS Foundation with an Enterprise account in addition to supporting us with any technical issues or questions we have faced.
101101

102-
### What is the 'origin'/'DO' server?
102+
### What is the origin/DO/www server?
103103

104104
This refers to the singular server instance that hosted the release assets (binaries, docs, shasums) among other things.
105105
This Worker aims to replace that server when it comes to serving the release assets.
@@ -115,4 +115,4 @@ Should any other pages be added to this worker, they should do the same unless a
115115

116116
## Additional Clarification
117117

118-
If you have any further questions, please feel free to reach out in [an Issue](https://github.com/nodejs/release-cloudflare-worker/issues/new) or the `#r2-website-migration` channel in the [OpenJS Foundation Slack](https://openjsf.org/collaboration).
118+
If you have any further questions, please feel free to reach out in [an Issue](https://github.com/nodejs/release-cloudflare-worker/issues/new) or the `#nodejs-website` channel in the [OpenJS Foundation Slack](https://openjsf.org/collaboration).

CONTRIBUTING.md

Lines changed: 8 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -24,32 +24,15 @@ You can find more details and guides about Collaborating with this repository th
2424

2525
### Becoming a Collaborator
2626

27-
A collaborator of the Node.js Release Worker repository is a member of the Node.js Web Infrastructure Team.
27+
A Collaborator of the Node.js Release Worker repository is a member of the Node.js Web Infrastructure Team.
2828

2929
The Web Infrastructure Team is responsible for maintaining the Infrastructure behind Node.js' Web Presence. It is expected that team members have significant knowledge about the infrastructure behind Node.js' Web Presence.
3030

31-
Note that regular contributors do not need to become "Collaborators" as any contribution is appreciated (even without a status), and a Collaborator status is a formality that comes with obligations.
31+
Note that regular Contributors do not need to become "Collaborators" as any contribution is appreciated (even without a status), and a Collaborator status is a formality that comes with obligations.
3232

33-
If you're an active contributor seeking to become a member, we recommend you contact one of the existing Team Members for guidance.
33+
If you're an active Contributor seeking to become a member, we recommend you contact one of the existing Team Members for guidance.
3434

35-
<details>
36-
<summary><b>What's the process for becoming a Collaborator?</b></summary>
37-
38-
- You must be actively contributing to this repository.
39-
- Contributions must include significant code reviews or code modifications.
40-
- A nomination must be done by an existing Team Member of the Web Infra team with an issue.
41-
- The Issue must explain and describe why the nominated person is a good addition to the team
42-
- The Issue must contain links to the relevant contributions, including but not limited to:
43-
- Code Reviews.
44-
- Comments on issues and PRs.
45-
- Authoring of PRs and issues.
46-
- The nomination must have at least three existing members of the Website Team agree with the nomination.
47-
- This can be done through commenting with "agreement" (showing support) or reacting to the Issue with a 👍 (Thumbs-up Emoji).
48-
- The Issue must be open for at least 72 hours without an objection from an existing member of the Website Team.
49-
- The nomination cannot pass until all open objections are resolved.
50-
- Objections from the TSC or Core Collaborators are also counted as valid objections.
51-
52-
</details>
35+
For information on how to become a Collaborator, see [GOVERNANCE.md](https://github.com/nodejs/nodejs.org/blob/main/GOVERNANCE.md#nodejs-web-infra-team-nodejsweb-infra) in the [nodejs/nodejs.org](https://github.com/nodejs/nodejs.org) repository.
5336

5437
## Getting Started
5538

@@ -141,15 +124,15 @@ This repository contains a few scripts and commands for performing numerous task
141124
<details>
142125
<summary>Commands for Running the Worker</summary>
143126

144-
- `npm start` Runs a local [workerd](https://github.com/cloudflare/workerd) instance with the Worker on your machine in remote mode.
127+
- `node --run start` Runs a local [workerd](https://github.com/cloudflare/workerd) instance with the Worker on your machine in remote mode.
145128

146129
</details>
147130

148131
## Commit Guidelines
149132

150-
This project follows the [Conventional Commits][https://www.conventionalcommits.org/en/v1.0.0/] specification.
133+
This project follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
151134

152-
Commits should be signed. You can read more about [Commit Signing][https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits] here.
135+
Commits should be signed. You can read more about [Commit Signing](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits) here.
153136

154137
### Commit Message Guidelines
155138

@@ -166,7 +149,7 @@ We recommend reading our [Collaborator Guide](./COLLABORATOR_GUIDE.md) for in-de
166149

167150
- Pull Requests must be open for at least 48 hours (or 72 hours if the PR was authored on the weekend).
168151
- If the Pull Request was marked as a draft, it must be marked "Ready for Review" for at least 48 hours (or 72 hours if done on a weekend) before being merged.
169-
- Pull Requests may be immediately merged if they contain critical fixes, short errata (e.g. typos), or any critical change considered a "showstopper" for the website's operation or security.
152+
- Pull Requests may be immediately merged if they contain critical fixes, short errata (e.g. typos), or any critical change considered a "showstopper" for the workers's operation or security.
170153
- This kind of Pull Request should only be done by existing Collaborators and/or signed off by administrators/maintainers.
171154
- This rule cannot be used for updates on the `COLLABORATOR_GUIDE.md`, `CONTRIBUTING.md`, `CODEOWNERS`, GitHub Actions, or any other document that changes the governing policies of this repository.
172155
- Pull Requests containing small bug fixes, small feature changes, or other non-critical/highly-impacting changes not covered by the previous rule that allows PRs to be merged immediately might be "fast-tracked". This means they can be merged before the usual 48 hour time period.

GOVERNANCE.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Node.js Web Team Governance
2+
3+
Please refer to the [GOVERNANCE.md](https://github.com/nodejs/nodejs.org/blob/main/GOVERNANCE.md) in the [nodejs/nodejs.org](https://github.com/nodejs/nodejs.org) repository.

0 commit comments

Comments
 (0)