Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: streamline CONTRIBUTING.md #24010

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
24 changes: 2 additions & 22 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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)
Expand All @@ -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)
Expand All @@ -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)

<a id="developers-certificate-of-origin"></a>
## Developer's Certificate of Origin 1.1
Expand Down
4 changes: 2 additions & 2 deletions doc/guides/contributing/pull-requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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

Expand Down