Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: update process to become a collaborator #5441

Merged
merged 5 commits into from
Jun 19, 2023
Merged

chore: update process to become a collaborator #5441

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5a1c284
chore: update process to become a collaborator
ovflowd Jun 17, 2023
07326ca
chore: amend changes
ovflowd Jun 17, 2023
e30ad96
chore: reformatted file
ovflowd Jun 17, 2023
ad1b73e
chore: apply code review changes
ovflowd Jun 18, 2023
2640cfa
chore: update username suggestion
ovflowd Jun 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
257 changes: 138 additions & 119 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,175 +3,198 @@
Thank you for your interest in contributing to the Node.js Website. Before you proceed, briefly go through the following:

- [Code of Conduct](https://github.com/nodejs/node/blob/HEAD/CODE_OF_CONDUCT.md)
- [Contributing](#contributing)
- [Getting started](#getting-started)
- [Vocabulary](#vocabulary)
- [Standards for making code changes](#standards-for-making-code-changes)
- [Commit message guidelines](#commit-guidelines)
- [Pull Request Policy](#pull-request-policy)
- [Before merging](#before-merging)
- [When merging](#when-merging)
- [Becoming a collaborator](#becoming-a-collaborator)
- [Developer's Certificate of Origin 1.1](#developers-certificate-of-origin-11)
- [Remarks](#remarks)

## Getting started
- [CLI Commands](#cli-commands)
- [Commit Guidelines](#commit-guidelines)
- [Pull Request Policy](#pull-request-policy)
- [Becoming a collaborator](#becoming-a-collaborator)
- [Developer's Certificate of Origin 1.1](#developers-certificate-of-origin-11)

1. Click the fork button in the top right to clone the [nodejs.org repository](https://github.com/nodejs/nodejs.org/fork)

2. Clone your fork using SSH, GitHub CLI, or HTTPS.
# Contributing

```bash
git clone git@github.com:<GITHUB_ID>/nodejs.org.git # SSH
git clone https://github.com/<GITHUB_ID>/nodejs.org.git # HTTPS
gh repo clone <GITHUB_ID>/nodejs.org # GitHub CLI
```

3. Change into the nodejs.org directory.
Any individual is welcome to contribute to the Node.js Website. The repository currently has two kinds of contribution personas:

```bash
cd nodejs.org
```

4. Create a remote for keeping your fork as well as your local clone up-to-date.
- A **Contributor** is any individual who creates an issue/PR, comments on an issue/PR
or contributes in some other way.
- A **Collaborator** is a contributor with write access to the repository. See [here](#becoming-a-collaborator) on how to become a collaborator.

```bash
git remote add upstream git@github.com:nodejs/nodejs.org.git # SSH
git remote add upstream https://github.com/nodejs/nodejs.org.git # HTTPS
gh repo sync nodejs/nodejs.org # GitHub CLI
```
You can find more details and guides about Collaborating with this repository through our [Collaborator Guide](./COLLABORATOR_GUIDE.md).

5. Create a new branch for your work.
## Becoming a Collaborator

```bash
git checkout -b name-of-your-branch
```
A collaborator of the Node.js Website repository is a member of the Node.js Website Team.

6. Run the following to install the dependencies and start a local preview of your work.
The Website Team is responsible for the technical development of the Node.js Website, thus it is expected
that team members have significant knowledge about modern Web Technologies and Web Standards.

```bash
npm ci # installs this project's dependencies
npx turbo serve # starts a preview of your local changes
```
Note that regular contributors do not need to become "Collaborators". Any contribution is appreciated and a Collaborator status
is a formality that comes with obligations.

7. Perform a merge to sync your current branch with the upstream branch.
If you're an active contributor seeking to become a member we recommend reaching out to one of the existing Team Members for guidance.

<details>
<summary><b>What's the processing for becoming a Collaborator?</b></summary>
ovflowd marked this conversation as resolved.
Show resolved Hide resolved
- You must be actively contributing to this repository.
ovflowd marked this conversation as resolved.
Show resolved Hide resolved
- Contributions must include significant code reviews or code contributions.
- A nomination must be done by an existing Team Member of the Website Team with an Issue
- The Issue must explain and describe why the nominated person is a good addition to the team
- The Issue must contain links to relevant contributions through:
- Code Reviews
- Comments on Issues and PRs
- Authoring of PRs or Issues
- Comments or Authoring of Discussions
- The nomination must have at least 3 existing members of the Website Team to be in agreement with the nomination.
- This can be done through commenting with "agreement" (showing support) or reacting to the Issue with a :+1: (Thumbs-up Emoji)
- The Issue must be open for at least 72 hours without an objection from an existing member of the Website Team
- The nomination cannot pass until all open discordances/objections are resolved.
- Objections coming from the TSC or Core Collaborators are also counted as valid objections.
</details>

```bash
git fetch upstream
git merge upstream/main
```
# Getting started

8. Run `npx turbo format` to confirm that linting, and formatting are passing.
The steps below will give you a general idea of how to prepare your local environment for the Node.js Website and general steps
for getting things done and landing your contribution.

```bash
npx turbo format
```

9. Once you're happy with your changes, add and commit them to your branch,
then push the branch to your fork.

```bash
cd ~/nodejs.org
git add .
git commit -m "some message"
git push -u origin name-of-your-branch
```
1. Click the fork button in the top right to clone the [nodejs.org repository](https://github.com/nodejs/nodejs.org/fork)
2. Clone your fork using SSH, GitHub CLI, or HTTPS.

10. Create a Pull Request. See [PR Policy](#pull-request-policy)
```bash
git clone git@github.com:<GITHUB_ID>/nodejs.org.git # SSH
ovflowd marked this conversation as resolved.
Show resolved Hide resolved
git clone https://github.com/<GITHUB_ID>/nodejs.org.git # HTTPS
gh repo clone <GITHUB_ID>/nodejs.org # GitHub CLI
```

> **Note**: Go through our [Commit](#commit-guidelines) and [Pull Request](#pull-request-policy) guidelines outlined below.
3. Change into the nodejs.org directory.

### CLI Options
```bash
cd nodejs.org
```

#### Serve/Build Options
4. Create a remote for keeping your fork as well as your local clone up-to-date.

- `npx turbo serve` runs Next.js's Local Development Server, listening by default on `http://localhost:3000/`.
- `npx turbo build` builds the Application on Production mode. The output is by default within `.next` folder.
- This is used for the Node.js Vercel Deployments (Preview & Production)
- `npx turbo deploy` builds the Application on Export Production Mode. The output is by default within `build` folder.
- This is used for the Node.js Legacy Website Server (DigitalOcean)
- `npx turbo start` starts a web server running serving the built content from `npx turbo build`
```bash
git remote add upstream git@github.com:nodejs/nodejs.org.git # SSH
git remote add upstream https://github.com/nodejs/nodejs.org.git # HTTPS
gh repo sync nodejs/nodejs.org # GitHub CLI
```

#### Other CLI options
5. Create a new branch for your work.

We also offer other commands that offer you assistance during your local development
```bash
git checkout -b name-of-your-branch
```

- `npx turbo lint` runs the linter for all the js files.
- `npx turbo lint:fix` attempts to fix any linting errors
- `npx turbo prettier` runs the prettier for all the js files.
- `npx turbo prettier:fix` attempts to fix any style errors
- `npx turbo format` formats and fixes the whole codebase
- `npx turbo scripts:release-post` generates a release post for the current release
- **Usage:** `npx turbo scripts:release-post -- --version=vXX.X.X --force`
- `npx turbo storybook` starts Storybook's local server
- `npx turbo storybook:build` builds Storybook as a static web application for publishing
- `npx turbo test` runs all tests locally
- `npx turbo test:unit` runs jest (unit-tests) locally
- `npx turbo test:storybook` runs storybook test-runner tests
- `npx turbo test:storybook:snapshot` generates and updates snapshots for all storybook components.
6. Run the following to install the dependencies and start a local preview of your work.

## Vocabulary
```bash
npm ci # installs this project's dependencies
npx turbo serve # starts a preview of your local changes
```

- A **Contributor** is any individual who creates an issue/PR, comments on an issue/PR
or contributes in some other way.
- A **Collaborator** is a contributor with write access to the repository. See [here](#becoming-a-collaborator) on how to become a collaborator.
7. Perform a merge to sync your current branch with the upstream branch.

## Standards for making code changes
```bash
git fetch upstream
git merge upstream/main
```

Refer to the [Collaborator Guide](COLLABORATOR_GUIDE.md#code-editing) for guidelines on code writing and editing.
8. Run `npx turbo format` to confirm that linting, and formatting are passing.

## Commit Guidelines
```bash
npx turbo format
```

9. Once you're happy with your changes, add and commit them to your branch, then push the branch to your fork.

```bash
cd ~/nodejs.org
git add .
git commit -m "some message"
git push -u origin name-of-your-branch
```

10. Create a Pull Request.

> **Note**: Before committing and opening a Pull Request please go first through our [Commit](#commit-guidelines) and [Pull Request](#pull-request-policy) guidelines outlined below.

## CLI Commands

This repository contains several scripts and commands for performing numerous tasks. The most relevant ones are described below.

<details>
<summary>Commands for Running & Building the Website</summary>
- `npx turbo serve` runs Next.js's Local Development Server, listening by default on `http://localhost:3000/`.
ovflowd marked this conversation as resolved.
Show resolved Hide resolved
- `npx turbo build` builds the Application on Production mode. The output is by default within `.next` folder.
- This is used for the Node.js Vercel Deployments (Preview & Production)
- `npx turbo deploy` builds the Application on Export Production Mode. The output is by default within `build` folder.
- This is used for the Node.js Legacy Website Server (DigitalOcean)
- `npx turbo start` starts a web server running serving the built content from `npx turbo build`
</details>

<details>
<summary>Commands for Maintenance Tasks and Tests</summary>
ovflowd marked this conversation as resolved.
Show resolved Hide resolved
- `npx turbo lint` runs the linter for all the js files.
- `npx turbo lint:fix` attempts to fix any linting errors
- `npx turbo prettier` runs the prettier for all the js files.
- `npx turbo prettier:fix` attempts to fix any style errors
- `npx turbo format` formats and fixes the whole codebase
- `npx turbo scripts:release-post` generates a release post for the current release
- **Usage:** `npx turbo scripts:release-post -- --version=vXX.X.X --force`
- `npx turbo storybook` starts Storybook's local server
- `npx turbo storybook:build` builds Storybook as a static web application for publishing
- `npx turbo test` runs all tests locally
- `npx turbo test:unit` runs jest (unit-tests) locally
- `npx turbo test:storybook` runs storybook test-runner tests
- `npx turbo test:storybook:snapshot` generates and updates snapshots for all storybook components.
</details>

# Commit Guidelines

This project follows the [Conventional Commits][] specification.

Commits should be signed. You can read more about [Commit Signing][] here.

### Commit Message guidelines
### Commit Message Guidelines

- Commit messages must include a "type"
> build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test
- Commit messages must include a "type" as described on Conventional Commits
- Commit messages **must** start with a capital letter
- Commit messages **must not** end with a period `.`

## Pull Request Policy
# Pull Request Policy

### Before merging
This policy governs how contributions should land within this repository. The lines below state the checks and policies to be followed before merging and on the act of merging.

## Before merging

We recommend a read on our [Collaborator Guide](COLLABORATOR_GUIDE.md#accepting-modifications) for in-depth details on how we accept contributions into this repository. The list below describes some of the merging and approval rules adopted in this repository.

- Pull Requests must be open for at least 48 hours (Or 72 hours if the PR was authored on the weekend).
- Pull requests might be immediately merged if they contain critical bug fixes, short erratas (e.g. typos from previous PRs) or any critical change that is considered a "showstopper" for the operation of the website.
- These kind of PRs should only be done by existing collaborators that have write-access and/or signed-off by administrators/maintainers.
- This rule cannot be used for updates on the COLLABORATOR_GUIDE, CONTRIBUTING guide, CODEOWNERS, GitHub Actions or any security-impacting file or document that changes the governing policies of this repository.
- Pull requests might be "fast-tracked", which means, they can be merged before the usual 48 hours notice if a "fast-track" label is added.
- Pull requests might be immediately merged if they contain critical bug fixes, short errata (e.g. typos from previous PRs) or any critical change that is considered a "showstopper" for the operation of the website.
- This kind of PRs should only be done by existing collaborators that have write-access and/or signed off by administrators/maintainers.
ovflowd marked this conversation as resolved.
Show resolved Hide resolved
- This rule cannot be used for updates on the `COLLABORATOR_GUIDE.md`, `CONTRIBUTING.md` guide, `CODEOWNERS`, GitHub Actions or any security-impacting file or document that changes the governing policies of this repository.
- Pull requests might be "fast-tracked", which means, they can be merged before the usual 48 hours' notice if a "fast-track" label is added.
- The person that is fast-tracking the PR (adding the label) must also comment on the PR that they're requesting the PR to be fast-tracked
- The comment must mention `@nodejs/website` and must have at least one 👍 (or any other sort of approval reaction) if the person fast-tracking the PR is the author of the PR.
- Fast-tracking is only allowed for small bug fixes, small feature changes, localisation changes, or other sort of non-critical/highly-impacting changes that are not covered by the previous rule that allows PRs to be merged immediately.
- Fast-tracking cannot be used for updates on the COLLABORATOR_GUIDE, CONTRIBUTING guide, CODEOWNERS, GitHub Actions or any security-impacting file or document that changes the governing policies of this repository.
- There must be no objections after a 48 hour period (Or 72 hours if the PR was authored on the weekend).
- Fast-tracking is only allowed for small bug fixes, small feature changes, localisation changes, or other sorts of non-critical/highly-impacting changes that are not covered by the previous rule that allows PRs to be merged immediately.
- Fast-tracking cannot be used for updates on the `COLLABORATOR_GUIDE.md`, CONTRIBUTING.md` guide, `CODEOWNERS`, GitHub Actions or any security-impacting file or document that changes the governing policies of this repository.
- There must be no objections after a 48-hour period (Or 72 hours if the PR was authored on the weekend).
HinataKah0 marked this conversation as resolved.
Show resolved Hide resolved
- At least one approval is required for any PR to be merged.
- Tests must be included in Pull Requests for new features or bug fixes. If any test(s) are failing, you are responsible for fixing them.

Each contribution is accepted only if there is no objection to it by a collaborator. During the review, collaborators may request that a specific contributor who is an expert in a particular area give an "LGTM" before the PR can be merged.

In the case that an objection is raised in a pull request by another collaborator, all collaborators involved should try to arrive at a consensus by addressing the concerns through discussion, compromise, or withdrawal of the proposed change(s).

### When merging
## When merging

- All required Status-checks must have passed.
- All discussions must be resolved.
- [`squash`][] pull requests made up of multiple commits

## Becoming a collaborator

- Collaborators must be actively contributing to the project
- A Pull Request must be opened on the @nodejs/nodejs.org README file adding the new collaborator to the list (note the order of names)
- The Pull Request must be approved by at least two members of @nodejs/website or @nodejs/tsc
- The Pull Request must remain open for 72 hours without any objections

More details about Collaboration can be found in the [COLLABORATOR_GUIDE.md](./COLLABORATOR_GUIDE.md).

## Developer's Certificate of Origin 1.1
# Developer's Certificate of Origin 1.1

```

By contributing to this project, I certify that:

- (a) The contribution was created in whole or in part by me and I have the right to
Expand All @@ -190,10 +213,6 @@ By contributing to this project, I certify that:

```

## Remarks

If something is missing here, or you feel something is not well described, feel free to open an [issue](https://github.com/nodejs/nodejs.org/issues) to discuss it.

[`squash`]: https://help.github.com/en/articles/about-pull-request-merges#squash-and-merge-your-pull-request-commits
[Conventional Commits]: https://www.conventionalcommits.org/
[Commit Signing]: https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits
Loading