Nock: Add multiple issue templates

Created on 3 Jul 2018  路  6Comments  路  Source: nock/nock

Most helpful comment

@jlilja I've invited you as a member of the organization. Let's get you set up so you can use GitHub's editor to work on these. :) Let me know if this doesn't work, or if you need help with anything.

All 6 comments

What types of templates should exist and what kind of information should they cover?

Glad you ask, and thank you for your help with the other issues, Jonas!

The idea is to create 4 files:

  1. .github/ISSUE_TEMPLATE/01_bug_report.md
  2. .github/ISSUE_TEMPLATE/02_feature_request.md
  3. .github/ISSUE_TEMPLATE/03_support.md
  4. .github/ISSUE_TEMPLATE/04_thanks.md

If you like to help out, I can invite you the repository so you can use GitHub鈥檚 editor:

image

For bug reports, I want people to create a reproducible test case using runkit.com, that will make it much easier for others to reproduce the problem and act on it. We can link an example (e.g. https://runkit.com/gr2m/node-nock-nock-768) and ideally also make a short tutorial to help people make it.

If people are not able to create the reproducible test case we should make clear that this might result in not getting help as nock is a volunteer community run project. But they can ask for help with the test case, which is an opportunity for others to jump in. Creating a reproducible test case is a great contribution to the project. We could use labels like has-test-case to differentiate and show people who want to help out a list of bug reports without one.

For feature requests, the template by babel is a good start: https://github.com/babel/babel/issues/new?template=Feature_request.md

For a support questions ("How do I ...?" questions) I prefer people to ask on Stack Overflow. I like babel鈥檚 template here, too: https://github.com/babel/babel/issues/new?template=Support_question.md. We could add more white space after the Click "Preview" for a nicer view! line so people wouldn鈥檛 see any other text, only after clicking the Preview tab

The Thanks template have two purposes

  1. Let people tell us how they use nock and where (at what company鈥檚). It will help us with fundraising for the future
  2. Tell people how they can help us today: star the repository, help triaging issues, help review pull requests, write blog posts, write tutorials, give talks, support us on https://opencollective.com/nock

Sounds like a very good start.

I'd like to help out any way I can, so you can invite me and I'll start working on it right away. 馃憤

@jlilja I've invited you as a member of the organization. Let's get you set up so you can use GitHub's editor to work on these. :) Let me know if this doesn't work, or if you need help with anything.

We've done this now! Thanks, @gr2m and @jlilja! 馃拑

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue and add a reference to this one if it鈥檚 related. Thank you!

Was this page helpful?
0 / 5 - 0 ratings

Related issues

timjonischkat picture timjonischkat  路  6Comments

glebsts picture glebsts  路  7Comments

danielb2 picture danielb2  路  5Comments

robinbobbitt picture robinbobbitt  路  5Comments

tinder-dyakobian picture tinder-dyakobian  路  6Comments