1# Issues 2 3* [How to Contribute in Issues](#how-to-contribute-in-issues) 4* [Asking for General Help](#asking-for-general-help) 5* [Discussing non-technical topics](#discussing-non-technical-topics) 6* [Submitting a Bug Report](#submitting-a-bug-report) 7* [Triaging a Bug Report](#triaging-a-bug-report) 8* [Resolving a Bug Report](#resolving-a-bug-report) 9 10## How to Contribute in Issues 11 12For any issue, there are fundamentally three ways an individual can 13contribute: 14 151. 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. 182. 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. 213. 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 26## Asking for General Help 27 28Because the level of activity in the `nodejs/node` repository is so high, 29questions or requests for general help using Node.js should be directed at 30the [Node.js help repository][]. 31 32## Discussing non-technical topics 33 34Discussion of non-technical topics (such as intellectual property and trademark) 35should be directed to the [Technical Steering Committee (TSC) repository][]. 36 37## Submitting a Bug Report 38 39When opening a new issue in the `nodejs/node` issue tracker, users will be 40presented with a basic template that should be filled in. 41 42```markdown 43<!-- 44Thank you for reporting an issue. 45 46This issue tracker is for bugs and issues found within Node.js core. 47If you require more general support please file an issue on our help 48repo. https://github.com/nodejs/help 49 50 51Please fill in as much of the template below as you're able. 52 53Version: output of `node -v` 54Platform: output of `uname -a` (UNIX), or version and 32 or 64-bit (Windows) 55Subsystem: if known, please specify affected core module name 56 57If possible, please provide code that demonstrates the problem, keeping it as 58simple and free of external dependencies as you are able. 59--> 60 61* **Version**: 62* **Platform**: 63* **Subsystem**: 64 65<!-- Enter your issue details below this comment. --> 66``` 67 68If you believe that you have uncovered a bug in Node.js, please fill out this 69form, following the template to the best of your ability. Do not worry if you 70cannot answer every detail, just fill in what you can. 71 72The two most important pieces of information we need in order to properly 73evaluate the report is a description of the behavior you are seeing and a simple 74test case we can use to recreate the problem on our own. If we cannot recreate 75the issue, it becomes impossible for us to fix. 76 77In order to rule out the possibility of bugs introduced by userland code, test 78cases should be limited, as much as possible, to using *only* Node.js APIs. 79If the bug occurs only when you're using a specific userland module, there is 80a very good chance that either (a) the module has a bug or (b) something in 81Node.js changed that broke the module. 82 83See [How to create a Minimal, Complete, and Verifiable example](https://stackoverflow.com/help/mcve). 84 85## Triaging a Bug Report 86 87Once an issue has been opened, it is common for there to be discussion 88around it. Some contributors may have differing opinions about the issue, 89including whether the behavior being seen is a bug or a feature. This discussion 90is part of the process and should be kept focused, helpful, and professional. 91 92The objective of helping with triaging issues (in core and help repos) is to 93help reduce the issue backlog and keep the issue tracker healthy, while enabling 94newcomers another meaningful way to get engaged and contribute. 95 96Anyone with a reasonable understanding of Node.js programming and the 97project's GitHub organization plus a few contributions to the project 98(commenting on issues or PRs) can apply for and become a triager. Open a PR 99on the README.md of this project with: i) a request to be added as a triager, 100ii) the motivation for becoming a triager, and iii) agreement on reading, 101understanding, and adhering to the project's [Code Of Conduct](https://github.com/nodejs/admin/blob/master/CODE_OF_CONDUCT.md). 102 103The triage role enables the ability to carry out the most common triage 104activities, such as applying labels and closing/reopening/assigning issues. 105For more information on the roles and permissions, see ["Permission levels for 106repositories 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). 107 108## Resolving a Bug Report 109 110In the vast majority of cases, issues are resolved by opening a Pull Request. 111The process for opening and reviewing a Pull Request is similar to that of 112opening and triaging issues, but carries with it a necessary review and approval 113workflow that ensures that the proposed changes meet the minimal quality and 114functional guidelines of the Node.js project. 115 116[Node.js help repository]: https://github.com/nodejs/help/issues 117[Technical Steering Committee (TSC) repository]: https://github.com/nodejs/TSC/issues 118