Skip to content

Commit 5cbf638

Browse files
Trottruyadorno
authored andcommitted
doc: remove unnecessary contributing.md section
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>
1 parent f99b38f commit 5cbf638

File tree

2 files changed

+0
-18
lines changed

2 files changed

+0
-18
lines changed

CONTRIBUTING.md

-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ See [details on our policy on Code of Conduct](./doc/guides/contributing/code-of
1515

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

18-
* [How to Contribute in Issues](./doc/guides/contributing/issues.md#how-to-contribute-in-issues)
1918
* [Asking for General Help](./doc/guides/contributing/issues.md#asking-for-general-help)
2019
* [Discussing non-technical topics](./doc/guides/contributing/issues.md#discussing-non-technical-topics)
2120
* [Submitting a Bug Report](./doc/guides/contributing/issues.md#submitting-a-bug-report)

doc/guides/contributing/issues.md

-17
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,11 @@
11
# Issues
22

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

10-
## How to Contribute in Issues
11-
12-
For any issue, there are fundamentally three ways an individual can
13-
contribute:
14-
15-
1. By opening the issue for discussion: For instance, if you believe that you
16-
have uncovered a bug in Node.js, creating a new issue in the `nodejs/node`
17-
issue tracker is the way to report it.
18-
2. By helping to triage the issue: This can be done either by providing
19-
supporting details (a test case that demonstrates a bug), or providing
20-
suggestions on how to address the issue.
21-
3. By helping to resolve the issue: Typically this is done either in the form
22-
of demonstrating that the issue reported is not a problem after all, or more
23-
often, by opening a Pull Request that changes some bit of something in
24-
`nodejs/node` in a concrete and reviewable manner.
25-
269
## Asking for General Help
2710

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

0 commit comments

Comments
 (0)