Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Latest commit

 

History

History
166 lines (113 loc) · 6.28 KB

CONTRIBUTING.md

File metadata and controls

166 lines (113 loc) · 6.28 KB
Raw

Contributing guide

Thank you for your interest in contributing to nodejs.dev. Before you proceed, briefly go through the following:

Code of Conduct

🚀 Getting started

  1. Click the fork button in the top right to clone the nodejs.dev repo

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

git clone [email protected]:<GITHUB_ID>/nodejs.dev.git # SSH
gh repo clone <GITHUB_ID>/nodejs.dev # GitHub CLI
git clone https://github.com/<GITHUB_ID>/nodejs.dev.git # HTTPS
  1. Change into the nodejs.dev directory.
cd nodejs.dev
  1. Create a remote for keeping your fork as well as your local clone up-to-date.
git remote add upstream [email protected]:nodejs/nodejs.dev.git
  1. Create a new branch for your work.
git checkout -b name-of-your-branch
  1. Run the following to install the dependencies and start a local preview of your work.
npm install # installs this project's dependencies
npm start # starts a preview of your local changes
  1. Perform a merge to sync your current branch with the upstream branch.
git fetch upstream
git merge upstream/main
  1. Run npm test to confirm that tests, linting, and formatting are passing. See here to fix failures. Ensure that your tests are passing before making a PR.
npm test

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

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

  2. Create a Pull Request. See PR Policy

Note: Go through our Commit and Pull Request(#-pull-request-policy) guidelines outlined below.

📝 Commit message guidelines

This project follows the Conventional Commits specification.

Basic rules:

Supported subsystems:

build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test

  • Commit messages must start with a capital letter

  • Commit messages must not end with a period .

📜 Pull Request Policy

Before merging

  • Pull Requests must be open for at least 48 hours.
    • Pull reuqests 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.
  • There must be no objections after a 48 hour period
  • 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

  • squash pull requests made up of multiple commits

Vocabulary

  • 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 on how to become a collaborator.

Becoming a collaborator

  • Collaborators must be actively contributing to the project
  • A Pull Request must be opened on the @nodejs/nodejs.dev 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/nodejs.dev, @nodejs/website, or @nodejs/website-redesign
  • The Pull Request must remain open for 72 hours without any objections

🐛 Debugging failing checks

  • For failing formatting or linting, try running:

    npm run format

  • Tests sometimes fail when you add or update HTML. Run the following to update snapshots:

npm run update-snapshot

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 submit it under the open source license indicated in the file; or
  • (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or
  • (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.
  • (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.

Remarks

If something is missing here, or you feel something is not well described, feel free to open an issue to discuss it.