Skip to content

Commit

Permalink
doc: remove unnecessary contributing.md section
Browse files Browse the repository at this point in the history
Remove "How to Contribute in Issues". This is not Node.js-specific and
is likely to cause many readers to tune out. If we want to include this
kind of how-all-issue-trackers-are-intended-to-work information, let's
link to an external source. But I think it's OK to simply remove it.

Refs: nodejs/TSC#864 (comment)

PR-URL: #36891
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
  • Loading branch information
Trott authored and targos committed May 1, 2021
1 parent 583b219 commit fa82cbc
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 18 deletions.
1 change: 0 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ See [details on our policy on Code of Conduct](./doc/guides/contributing/code-of

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

* [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)
* [Submitting a Bug Report](./doc/guides/contributing/issues.md#submitting-a-bug-report)
Expand Down
17 changes: 0 additions & 17 deletions doc/guides/contributing/issues.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,11 @@
# Issues

* [How to Contribute in Issues](#how-to-contribute-in-issues)
* [Asking for General Help](#asking-for-general-help)
* [Discussing non-technical topics](#discussing-non-technical-topics)
* [Submitting a Bug Report](#submitting-a-bug-report)
* [Triaging a Bug Report](#triaging-a-bug-report)
* [Resolving a Bug Report](#resolving-a-bug-report)

## How to Contribute in Issues

For any issue, there are fundamentally three ways an individual can
contribute:

1. By opening the issue for discussion: For instance, if you believe that you
have uncovered a bug in Node.js, creating a new issue in the `nodejs/node`
issue tracker is the way to report it.
2. By helping to triage the issue: This can be done either by providing
supporting details (a test case that demonstrates a bug), or providing
suggestions on how to address the issue.
3. By helping to resolve the issue: Typically this is done either in the form
of demonstrating that the issue reported is not a problem after all, or more
often, by opening a Pull Request that changes some bit of something in
`nodejs/node` in a concrete and reviewable manner.

## Asking for General Help

Because the level of activity in the `nodejs/node` repository is so high,
Expand Down

0 comments on commit fa82cbc

Please sign in to comment.