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

docs(contributing.md): Added details on how to contribute #397

Merged
benhalverson merged 2 commits into from
Feb 29, 2020
Merged

docs(contributing.md): Added details on how to contribute #397

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
82ebf04
docs(contributing.md): Added details on how to contribute
benhalverson Feb 11, 2020
7dea6af
docs(contributing.md): Updated the getting started section
benhalverson Feb 15, 2020
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
22 changes: 19 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

## Vocabulary

* A **Contributor** is any individual creating or commenting on an issue or pull request,
- A **Contributor** is any individual creating or commenting on an issue or pull request,
or contributing in some other way.
* A **Collaborator** is a contributor who has been given write access to the repository.
- A **Collaborator** is a contributor who has been given write access to the repository.

## Commit Guidelines

Expand Down Expand Up @@ -44,7 +44,7 @@ Pull requests seeking to make any of the following changes do not need to wait 2
- There must be at least one sign off
- There must be no objections after a 48 hour period

The default for each contribution is that it is accepted once no collaborator has an objection. During review collaborators may also request that a specific contributor who is most versed in a particular area gives a "LGTM" before the PR can be merged.
The default for each contribution is that it is accepted once no collaborator has an objection. During review collaborators may also request that a specific contributor who is most versed in a particular area gives a "LGTM" before the PR can be merged.

In the case of an objection being raised in a pull request by another collaborator, all involved collaborators should seek to arrive at a consensus by way of addressing concerns being expressed by discussion, compromise on the proposed change, or withdrawal of the proposed change.

Expand All @@ -54,6 +54,22 @@ In the case of an objection being raised in a pull request by another collaborat
- [`squash`][] pull-requests made up of multiple commits
- Land how you like as long as there are no merge commits

## Getting Started

For feature development you should be working from the staging branch.

- Fork
- Clone your fork `git clone git@github.com:<githubid>/nodejs.dev.git`
- cd into your project
- Add the following to your remotes by doing `git remote add upstream git@github.com:nodejs/nodejs.dev.git`
- Check out the staging branch by doing `git checkout upstream/staging`
- Create a new branch for your awesome work `git checkout -b branchname`
- Commit your work
- Push to your branch `git push -u origin yourbranch`
- Make a pull request against the remote branch `staging`
- Example `https://github.com/nodejs/nodejs.dev/pull/398`
- Mention @nodejs/website-redesign `/gcbrun`

## Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:
Expand Down