From 7e1b178fb637abc68b1d4da1363a19db7ad02d6c Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Wed, 31 Oct 2018 21:57:58 -0700 Subject: [PATCH] doc: streamline CONTRIBUTING.md PR-URL: https://github.com/nodejs/node/pull/24010 Reviewed-By: James M Snell Reviewed-By: Daniel Bevenius --- CONTRIBUTING.md | 24 ++---------------------- doc/guides/contributing/pull-requests.md | 4 ++-- 2 files changed, 4 insertions(+), 24 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 684277980a8..1a3babf8405 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,18 +1,5 @@ # 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) * [Issues](#issues) * [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 [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 -*minimum* behavior expectations for all contributors. +to which all contributors must adhere. See [details on our policy on Code of Conduct](./doc/guides/contributing/coc.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) * [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) @@ -41,14 +24,11 @@ general discussions are made. ## [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) * [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) * [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) ## Developer's Certificate of Origin 1.1 diff --git a/doc/guides/contributing/pull-requests.md b/doc/guides/contributing/pull-requests.md index 15c31cec714..2c0d8d6ccb7 100644 --- a/doc/guides/contributing/pull-requests.md +++ b/doc/guides/contributing/pull-requests.md @@ -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) * [Performance is not everything](#performance-is-not-everything) * [Continuous Integration Testing](#continuous-integration-testing) -* [Additional Notes](#additional-notes) +* [Notes](#notes) * [Commit Squashing](#commit-squashing) * [Getting Approvals for your Pull Request](#getting-approvals-for-your-pull-request) * [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 whether the failure was caused by the changes in the Pull Request. -## Additional Notes +## Notes ### Commit Squashing