Skip to content

CONTRIBUTING.md should direct "help me" type questions to the help repo #3185

Description

@Trott

CONTRIBUTING.md should explain briefly what types of issues are appropriate for this issue tracker and provide a link to https://github.com/nodejs/help/issues for issues that are more appropriate for that issue tracker.

Activity

  1. added
    good first issueIssues that are suitable for first-time contributors.
    on Oct 5, 2015
  2. added
    docIssues and PRs related to Node.js documentation.
    on Oct 5, 2015
  3. bigtone1284 commented on Oct 6, 2015

    @bigtone1284

    I'd love to get involved, but it seems that this issue has been settled...yes?

  4. Trott commented on Oct 6, 2015

    @Trott
    MemberAuthor

    @bigtone1284: CONTRIBUTING.md directs non-technical discussion to the node-forward repo, but it does not tell people what to do if they have technical questions that aren't issues in/with/around Node.

    For example:

    • If you have some code that throws an error when it should not throw an error, and you think it is doing this because of a reproducible bug in Node.js, then this is totally the right issue tracker to use.
    • On the other hand, if you are trying to create an http server in Node.js and you just can't figure out how to do it and it's probably something you're doing wrong with a callback but you're not sure what it is and you'd like help figuring it out...that's not a problem with Node, that's a request for help, and that should be filed at https://github.com/nodejs/help/issues instead.

    This information needs to be conveyed in CONTRIBUTING.md in a much more succinct fashion than I am doing here.

    If you are up for trying to explain this clearly, concisely, and positively, please submit a PR!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    docIssues and PRs related to Node.js documentation.good first issueIssues that are suitable for first-time contributors.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions