Skip to content

Commit 6f54a7a

Browse files
Trotttargos
authored andcommittedNov 5, 2018
doc: streamline CONTRIBUTING.md
PR-URL: #24010 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
1 parent 3b10440 commit 6f54a7a

File tree

2 files changed

+4
-24
lines changed

2 files changed

+4
-24
lines changed
 

‎CONTRIBUTING.md

+2-22
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,5 @@
11
# Contributing to Node.js
22

3-
Contributions to Node.js include code, documentation, answering user questions,
4-
running the project's infrastructure, and advocating for all types of Node.js
5-
users.
6-
7-
The Node.js project welcomes all contributions from anyone willing to work in
8-
good faith with other contributors and the community. No contribution is too
9-
small and all contributions are valued.
10-
11-
This guide explains the process for contributing to the Node.js project's core
12-
`nodejs/node` GitHub Repository and describes what to expect at each step.
13-
14-
## Contents
15-
163
* [Code of Conduct](#code-of-conduct)
174
* [Issues](#issues)
185
* [Pull Requests](#pull-requests)
@@ -22,16 +9,12 @@ This guide explains the process for contributing to the Node.js project's core
229

2310
The Node.js project has a
2411
[Code of Conduct](https://github.com/nodejs/admin/blob/master/CODE_OF_CONDUCT.md)
25-
that *all* contributors are expected to follow. This code describes the
26-
*minimum* behavior expectations for all contributors.
12+
to which all contributors must adhere.
2713

2814
See [details on our policy on Code of Conduct](./doc/guides/contributing/coc.md).
2915

3016
## [Issues](./doc/guides/contributing/issues.md)
3117

32-
Issues in `nodejs/node` are the primary means by which bug reports and
33-
general discussions are made.
34-
3518
* [How to Contribute in Issues](./doc/guides/contributing/issues.md#how-to-contribute-in-issues)
3619
* [Asking for General Help](./doc/guides/contributing/issues.md#asking-for-general-help)
3720
* [Discussing non-technical topics](./doc/guides/contributing/issues.md#discussing-non-technical-topics)
@@ -41,14 +24,11 @@ general discussions are made.
4124

4225
## [Pull Requests](./doc/guides/contributing/pull-requests.md)
4326

44-
Pull Requests are the way concrete changes are made to the code, documentation,
45-
dependencies, and tools contained in the `nodejs/node` repository.
46-
4727
* [Dependencies](./doc/guides/contributing/pull-requests.md#dependencies)
4828
* [Setting up your local environment](./doc/guides/contributing/pull-requests.md#setting-up-your-local-environment)
4929
* [The Process of Making Changes](./doc/guides/contributing/pull-requests.md#the-process-of-making-changes)
5030
* [Reviewing Pull Requests](./doc/guides/contributing/pull-requests.md#reviewing-pull-requests)
51-
* [Additional Notes](./doc/guides/contributing/pull-requests.md#additional-notes)
31+
* [Notes](./doc/guides/contributing/pull-requests.md#notes)
5232

5333
<a id="developers-certificate-of-origin"></a>
5434
## Developer's Certificate of Origin 1.1

‎doc/guides/contributing/pull-requests.md

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

534-
## Additional Notes
534+
## Notes
535535

536536
### Commit Squashing
537537

0 commit comments

Comments
 (0)