From 9886d5ebf93df10ac6cbf607abfe61e503bb33ed Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Tue, 12 Jan 2021 06:34:00 -0800 Subject: [PATCH] doc: remove unnecessary contributing.md section MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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: https://github.com/nodejs/TSC/issues/864#issuecomment-628646560 PR-URL: https://github.com/nodejs/node/pull/36891 Reviewed-By: Michaël Zasso Reviewed-By: James M Snell Reviewed-By: Michael Dawson --- CONTRIBUTING.md | 1 - doc/guides/contributing/issues.md | 17 ----------------- 2 files changed, 18 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 29700978fb78bf..d4ba35f6252271 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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) diff --git a/doc/guides/contributing/issues.md b/doc/guides/contributing/issues.md index 44b18bc8ede7d2..9af1f37ff4c9da 100644 --- a/doc/guides/contributing/issues.md +++ b/doc/guides/contributing/issues.md @@ -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,