1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: streamline CONTRIBUTING.md

Browse Source 
PR-URL: https://github.com/nodejs/node/pull/24010
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
This commit is contained in:
Rich Trott 2018-10-31 21:57:58 -07:00 committed by Daniel Bevenius
parent b623491371
commit 7e1b178fb6
2 changed files with 4 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
CONTRIBUTING.md
View File

@ -1,18 +1,5 @@
# Contributing to Node.js # Contributing to Node.js
Contributions to Node.js include code, documentation, answering user questions,
running the project's infrastructure, and advocating for all types of Node.js
users.
The Node.js project welcomes all contributions from anyone willing to work in
good faith with other contributors and the community. No contribution is too
small and all contributions are valued.
This guide explains the process for contributing to the Node.js project's core
`nodejs/node` GitHub Repository and describes what to expect at each step.
## Contents
* [Code of Conduct](#code-of-conduct) * [Code of Conduct](#code-of-conduct)
* [Issues](#issues) * [Issues](#issues)
* [Pull Requests](#pull-requests) * [Pull Requests](#pull-requests)
@ -22,16 +9,12 @@ This guide explains the process for contributing to the Node.js project's core
The Node.js project has a The Node.js project has a
[Code of Conduct](https://github.com/nodejs/admin/blob/master/CODE_OF_CONDUCT.md) [Code of Conduct](https://github.com/nodejs/admin/blob/master/CODE_OF_CONDUCT.md)
that *all* contributors are expected to follow. This code describes the to which all contributors must adhere.
*minimum* behavior expectations for all contributors.
See [details on our policy on Code of Conduct](./doc/guides/contributing/coc.md). See [details on our policy on Code of Conduct](./doc/guides/contributing/coc.md).
## [Issues](./doc/guides/contributing/issues.md) ## [Issues](./doc/guides/contributing/issues.md)
Issues in `nodejs/node` are the primary means by which bug reports and
general discussions are made.
* [How to Contribute in Issues](./doc/guides/contributing/issues.md#how-to-contribute-in-issues) * [How to Contribute in Issues](./doc/guides/contributing/issues.md#how-to-contribute-in-issues)
* [Asking for General Help](./doc/guides/contributing/issues.md#asking-for-general-help) * [Asking for General Help](./doc/guides/contributing/issues.md#asking-for-general-help)
* [Discussing non-technical topics](./doc/guides/contributing/issues.md#discussing-non-technical-topics) * [Discussing non-technical topics](./doc/guides/contributing/issues.md#discussing-non-technical-topics)
@ -41,14 +24,11 @@ general discussions are made.
## [Pull Requests](./doc/guides/contributing/pull-requests.md) ## [Pull Requests](./doc/guides/contributing/pull-requests.md)
Pull Requests are the way concrete changes are made to the code, documentation,
dependencies, and tools contained in the `nodejs/node` repository.
* [Dependencies](./doc/guides/contributing/pull-requests.md#dependencies) * [Dependencies](./doc/guides/contributing/pull-requests.md#dependencies)
* [Setting up your local environment](./doc/guides/contributing/pull-requests.md#setting-up-your-local-environment) * [Setting up your local environment](./doc/guides/contributing/pull-requests.md#setting-up-your-local-environment)
* [The Process of Making Changes](./doc/guides/contributing/pull-requests.md#the-process-of-making-changes) * [The Process of Making Changes](./doc/guides/contributing/pull-requests.md#the-process-of-making-changes)
* [Reviewing Pull Requests](./doc/guides/contributing/pull-requests.md#reviewing-pull-requests) * [Reviewing Pull Requests](./doc/guides/contributing/pull-requests.md#reviewing-pull-requests)
* [Additional Notes](./doc/guides/contributing/pull-requests.md#additional-notes) * [Notes](./doc/guides/contributing/pull-requests.md#notes)
<a id="developers-certificate-of-origin"></a> <a id="developers-certificate-of-origin"></a>
## Developer's Certificate of Origin 1.1 ## Developer's Certificate of Origin 1.1

4
doc/guides/contributing/pull-requests.md
View File

@ -29,7 +29,7 @@ so that you can make the actual changes. This is where we will start.
* [Accept that there are different opinions about what belongs in Node.js](#accept-that-there-are-different-opinions-about-what-belongs-in-nodejs) * [Accept that there are different opinions about what belongs in Node.js](#accept-that-there-are-different-opinions-about-what-belongs-in-nodejs)
* [Performance is not everything](#performance-is-not-everything) * [Performance is not everything](#performance-is-not-everything)
* [Continuous Integration Testing](#continuous-integration-testing) * [Continuous Integration Testing](#continuous-integration-testing)
* [Additional Notes](#additional-notes) * [Notes](#notes)
* [Commit Squashing](#commit-squashing) * [Commit Squashing](#commit-squashing)
* [Getting Approvals for your Pull Request](#getting-approvals-for-your-pull-request) * [Getting Approvals for your Pull Request](#getting-approvals-for-your-pull-request)
* [CI Testing](#ci-testing) * [CI Testing](#ci-testing)
@ -531,7 +531,7 @@ specific platforms or for so-called "flaky" tests to fail ("be red"). It is
vital to visually inspect the results of all failed ("red") tests to determine vital to visually inspect the results of all failed ("red") tests to determine
whether the failure was caused by the changes in the Pull Request. whether the failure was caused by the changes in the Pull Request.
## Additional Notes ## Notes
### Commit Squashing ### Commit Squashing