├── .github ├── ISSUE_TEMPLATE │ ├── config.yml │ └── help.yml └── workflows │ └── close-stale-issues.yml └── README.md /.github/ISSUE_TEMPLATE/config.yml: -------------------------------------------------------------------------------- 1 | blank_issues_enabled: false 2 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/help.yml: -------------------------------------------------------------------------------- 1 | name: General Help 2 | description: Get general support regarding Node.js 3 | body: 4 | - type: input 5 | attributes: 6 | label: Node.js Version 7 | description: This can be found via the `node -v` command 8 | placeholder: v0.0.0 9 | validations: 10 | required: true 11 | - type: input 12 | attributes: 13 | label: NPM Version 14 | description: This can be found via the `npm -v` command 15 | placeholder: v0.0.0 16 | validations: 17 | required: true 18 | - type: input 19 | attributes: 20 | label: Operating System 21 | description: >- 22 | This can be found via the `uname -a` command, or via System Information 23 | on windows 24 | validations: 25 | required: true 26 | - type: dropdown 27 | attributes: 28 | label: Subsystem 29 | description: What area of Node.js are you experiencing touble with? 30 | multiple: true 31 | options: 32 | - assert 33 | - async_hooks 34 | - buffer 35 | - child_process 36 | - cluster 37 | - console 38 | - constants 39 | - crypto 40 | - dgram 41 | - diagnostics_channel 42 | - dns 43 | - domain 44 | - events 45 | - fs 46 | - http 47 | - http2 48 | - https 49 | - inspector 50 | - path 51 | - perf_hooks 52 | - process 53 | - punycode 54 | - querystring 55 | - readline 56 | - repl 57 | - sqlite 58 | - stream 59 | - string_decoder 60 | - timers 61 | - tls 62 | - trace_events 63 | - tty 64 | - url 65 | - util 66 | - v8 67 | - vm 68 | - wasi 69 | - worker_threads 70 | - zlib 71 | - Other 72 | validations: 73 | required: true 74 | - type: textarea 75 | attributes: 76 | label: Description 77 | description: A clear and concise description of the problem 78 | validations: 79 | required: true 80 | - type: textarea 81 | attributes: 82 | label: Minimal Reproduction 83 | description: provide steps to reproduce the problem 84 | - type: textarea 85 | attributes: 86 | label: Output 87 | description: provide the error/output to show the issue 88 | - type: checkboxes 89 | attributes: 90 | label: Before You Submit 91 | options: 92 | - label: I have looked for issues that already exist before submitting this 93 | required: true 94 | - label: >- 95 | My issue follows the guidelines in the README file, and follows the 96 | 'How to ask a good question' guide at 97 | https://stackoverflow.com/help/how-to-ask 98 | required: true 99 | -------------------------------------------------------------------------------- /.github/workflows/close-stale-issues.yml: -------------------------------------------------------------------------------- 1 | name: Close stale issues/prs 2 | on: 3 | workflow_dispatch: 4 | schedule: 5 | # Run every day at 1:00 AM UTC. 6 | - cron: 0 1 * * * 7 | 8 | # yamllint disable rule:empty-lines 9 | env: 10 | CLOSE_MESSAGE: > 11 | It seems there has been no activity on this issue for a while, 12 | and it is being closed. If you believe this issue should 13 | remain open, please leave a comment. 14 | 15 | If you need further assistance or have questions, you can 16 | also search for similar issues on [Stack Overflow](https://stackoverflow.com/). 17 | 18 | Make sure to look at the README file for the most updated links. 19 | 20 | WARN_MESSAGE: > 21 | It seems there has been no activity on this issue for a while, 22 | and it is being closed **in 30 days**. If you believe this issue should 23 | remain open, please leave a comment. 24 | 25 | If you need further assistance or have questions, you can 26 | also search for similar issues on [Stack Overflow](https://stackoverflow.com/). 27 | 28 | Make sure to look at the README file for the most updated links. 29 | # yamllint enable 30 | 31 | permissions: 32 | contents: read 33 | issues: write 34 | pull-requests: write 35 | actions: write 36 | jobs: 37 | stale: 38 | if: github.repository == 'nodejs/help' 39 | runs-on: ubuntu-latest 40 | steps: 41 | - uses: actions/stale@28ca1036281a5e5922ead5184a1bbf96e5fc984e #v9.0.0 42 | with: 43 | repo-token: ${{ secrets.GITHUB_TOKEN }} 44 | days-before-stale: 180 45 | days-before-close: 30 46 | stale-issue-message: ${{ env.WARN_MESSAGE }} 47 | stale-pr-message: ${{ env.WARN_MESSAGE }} 48 | close-issue-message: ${{ env.CLOSE_MESSAGE }} 49 | close-pr-message: ${{ env.CLOSE_MESSAGE }} 50 | exempt-issue-labels: never-stale 51 | exempt-pr-labels: never-stale 52 | stale-pr-label: stale 53 | stale-issue-label: stale 54 | operations-per-run: 500 55 | remove-stale-when-updated: true 56 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Node.js Help 2 | 3 |

4 | 5 | 6 | 7 | 8 |

9 | 10 | ## Welcome to Node.js Help! 11 | 12 | Whether you're a beginner or an experienced developer, Node.js Help is here to assist you with all your Node.js questions and concerns. 13 | 14 | For more information on Node.js, including installation and building, visit the [nodejs/node](https://github.com/nodejs/node) repository. 15 | 16 | ## How to Ask a Good Question 17 | 18 | ### 1. **Be Specific** 19 | - **Provide Context:** Explain the background or context of your question. This helps others understand your problem or inquiry better. 20 | - **Avoid Ambiguity:** Clearly state what you're asking about. Vague questions can lead to misunderstandings or irrelevant responses. 21 | 22 | ### 2. **Use Clear Language** 23 | - **Avoid Jargon:** If your question involves technical terms, ensure they are explained or defined. 24 | - **Be Concise:** Keep your question brief and to the point. Long-winded questions can be confusing and may lose the reader's interest. 25 | 26 | ### 3. **State Your Goal** 27 | - **Clarify Your Objective:** Explain why you're asking the question and what you hope to achieve by getting an answer. 28 | - **Express Your Expectations:** Let others know what kind of answer you're looking for. 29 | 30 | ### 4. **Provide Relevant Details** 31 | - **Include Relevant Information:** Give details that are pertinent to your question. This could include error messages, steps you've already taken, or relevant background information. 32 | - **Exclude Irrelevant Details:** Avoid cluttering your question with unnecessary information that may distract from the main issue. 33 | 34 | ### 5. **Be Respectful** 35 | - **Be Polite:** Remember to use polite language and tone, even if you're frustrated or facing challenges. 36 | - **Appreciate Responses:** When someone takes the time to answer your question, thank them for their help, even if the answer doesn't fully solve your problem. 37 | 38 | ### 6. **Check for Duplicates** 39 | - **Search Before Asking:** Before posting your question, search to see if it has already been asked and answered. Duplicate questions can clutter forums and waste people's time. 40 | 41 | ### 7. **Format Appropriately** 42 | - **Use Proper Formatting:** If you're asking your question on a platform that supports formatting (like a forum or Q&A site), use formatting to make your question more readable. Use headers, lists, and code blocks as needed. 43 | 44 | ### 8. **Proofread Your Question** 45 | - **Check for Errors:** Proofread your question before posting to ensure clarity and correctness. Typos or grammar mistakes can make your question harder to understand. 46 | 47 | ### 9. **Be Open to Feedback** 48 | - **Accept Criticism:** If someone suggests improvements to your question, consider their feedback constructively. It can help you ask better questions in the future. 49 | 50 | ### 10. **Follow Up** 51 | - **Engage with Responses:** Once you receive answers, engage with them. Ask for clarification if needed, and provide feedback on whether the answers were helpful. 52 | 53 | ## What to Ask: 54 | 55 | ### 1. Clear and Specific Questions: 56 | - How can I achieve _\[specific task]_ in my Node.js application? 57 | - What is the best way to handle _\[specific problem]_ in Node.js? 58 | - Can someone help me understand how _\[specific feature]_ in Node.js works? 59 | 60 | ### 2. Troubleshooting Questions: 61 | - I'm encountering _\[specific error]_ when trying to _\[specific action]_. How can I resolve this? 62 | - What could be causing _\[specific behavior]_ in my Node.js code? 63 | 64 | ### 3. Conceptual Questions: 65 | - Can someone explain the difference between _\[concept A]_ and _\[concept B]_ in Node.js? 66 | - How does _\[specific module or feature]_ in Node.js work under the hood? 67 | 68 | ## What NOT to Ask: 69 | 70 | ### 1. General Programming Questions: 71 | - How do I write a for loop in JavaScript? 72 | - What is HTML, and how does it work? 73 | 74 | ### 2. Personal Debugging: 75 | - Would someone be able to debug my entire Node.js project for me? 76 | - Why isn't my code working? (without providing any specific details or code snippets) 77 | 78 | ### 3. Unsupported or External Package Issues: 79 | - I need help with a third-party package (not related to Node.js core). Can someone help? 80 | - Why doesn't this external package work in my Node.js project? 81 | 82 | ### 4. Opinion-Based Questions: 83 | - What is the best Node.js framework? 84 | - Which is better, callback functions or Promises? 85 | 86 | ### 5. Duplicate Questions: 87 | - I didn't find an answer to my question, but it's similar to this other question. Can someone help me anyway? 88 | - Why hasn't anyone answered my question yet? (without considering it might be a duplicate) 89 | 90 | ### 6. Requests for Complete Solutions: 91 | - Can someone write the entire code for my project? 92 | - I need help with my homework. Can someone do it for me? 93 | 94 | ### 7. Unrelated or Off-Topic Questions: 95 | - What's the weather like in New York today? 96 | - Can someone help me with my personal relationship issues? 97 | 98 | ### 8. Extremely Broad Questions: 99 | - How do I become a Node.js expert? 100 | - What can I do with Node.js? 101 | 102 | #### Note 103 | 104 | When inserting your code, use 3 backticks, followed by `js` as shown below: 105 | ```` 106 | ```js 107 | console.log('happy coding!'); 108 | ``` 109 | ```` 110 | ```js 111 | console.log('happy coding!'); 112 | ``` 113 | 114 | ## Participate 115 | 116 | You can participate by asking or answering open questions in the [issues section](https://github.com/nodejs/help/issues). 117 | 118 | ## External Links 119 | 120 | - [Node.js Official Website](https://nodejs.org/) 121 | - [Node.js Documentation](https://nodejs.org/docs/latest/api/) 122 | - [Node.js GitHub Repository](https://github.com/nodejs/node) 123 | - [Node.js Slack](https://node-js.slack.com/) *([join here](https://www.nodeslackers.com/))* 124 | - [Node.js Discord](https://nodejs.org/discord) 125 | - [#nodejs channel](https://openjs-foundation.slack.com/archives/CK9Q4MB53) on the OpenJS Foundation Slack *([join here](https://slack-invite.openjsf.org/))* 126 | - [#node.js channel on libera.chat](https://web.libera.chat?channels=node.js&uio=d4) 127 | --------------------------------------------------------------------------------