• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Issues
2
3* [Asking for general help](#asking-for-general-help)
4* [Discussing non-technical topics](#discussing-non-technical-topics)
5* [Submitting a bug report](#submitting-a-bug-report)
6* [Triaging a bug report](#triaging-a-bug-report)
7
8## Asking for general help
9
10Because the level of activity in the `nodejs/node` repository is so high,
11questions or requests for general help using Node.js should be directed at
12the [Node.js help repository][].
13
14## Discussing non-technical topics
15
16Discussion of non-technical topics (such as intellectual property and trademark)
17should be directed to the [Technical Steering Committee (TSC) repository][].
18
19## Submitting a bug report
20
21When opening a new issue in the `nodejs/node` issue tracker, users will be
22presented with a choice of issue templates. If you believe that you have
23uncovered a bug in Node.js, please fill out the `Bug Report` template to the
24best of your ability. Do not worry if you cannot answer every detail; just fill
25in what you can.
26
27The two most important pieces of information we need in order to properly
28evaluate the report is a description of the behavior you are seeing and a simple
29test case we can use to recreate the problem on our own. If we cannot recreate
30the issue, it becomes impossible for us to fix.
31
32In order to rule out the possibility of bugs introduced by userland code, test
33cases should be limited, as much as possible, to using *only* Node.js APIs.
34If the bug occurs only when you're using a specific userland module, there is
35a very good chance that either (a) the module has a bug or (b) something in
36Node.js changed that broke the module.
37
38See [How to create a Minimal, Complete, and Verifiable example](https://stackoverflow.com/help/mcve).
39
40## Triaging a bug report
41
42Once an issue has been opened, it is common for there to be discussion
43around it. Some contributors may have differing opinions about the issue,
44including whether the behavior being seen is a bug or a feature. This discussion
45is part of the process and should be kept focused, helpful, and professional.
46
47The objective of helping with triaging issues (in core and help repos) is to
48help reduce the issue backlog and keep the issue tracker healthy, while enabling
49newcomers another meaningful way to get engaged and contribute.
50
51Anyone with a reasonable understanding of Node.js programming and the
52project's GitHub organization plus a few contributions to the project
53(commenting on issues or PRs) can apply for and become a triager. Open a PR
54on the README.md of this project with: i) a request to be added as a triager,
55ii) the motivation for becoming a triager, and iii) agreement on reading,
56understanding, and adhering to the project's [Code Of Conduct](https://github.com/nodejs/admin/blob/HEAD/CODE_OF_CONDUCT.md).
57
58The triage role enables the ability to carry out the most common triage
59activities, such as applying labels and closing/reopening/assigning issues.
60For more information on the roles and permissions, see ["Permission levels for
61repositories owned by an organization"](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization).
62
63[Node.js help repository]: https://github.com/nodejs/help/issues
64[Technical Steering Committee (TSC) repository]: https://github.com/nodejs/TSC/issues
65