search

noirbizarre / flask-restplus

Fully featured framework for fast, easy and documented API development with Flask
http://flask-restplus.readthedocs.org
Other
2.73k stars 507 forks source link

Create an issue template #689

Open JaDogg opened 5 years ago

JaDogg commented 5 years ago

It would be good to create an issue template so new issues have relevant details up front.

Sample:

1) What is the error message? Please copy paste and format it properly. Please use images only for rendering bugs. 2) What are the steps to reproduce this error? 3) Can you provide relevant code 4) Can you provide following information?

a-luna commented 5 years ago

I’ll take a stab at creating issue and PR templates. For issue templates, it’s pretty common for a project to have separate templates for bugs vs questions vs feature requests/enhancements. If there’s no objection to adopting this approach, we should discuss what the best default values for each issue template would be, if any.

I have also seen some projects that explicitly forbid creating github issues asking for help/support. Instead the user is directed to stack overflow in order to receive support. This tends to occur for projects that have a large user base (I have definitely seen questions on SO about Flask-RESTPlus). Enforcing this policy would focus our issue list on just bugs/enhancements.

Please let me know your thoughts, I’ll submit a PR with a proposed bug/defect template (i.e., NOT help/enhancement template) first since I’d like to hear feedback on the help/support policy first.

a-luna commented 5 years ago

@JaDogg, thank you for providing an example template to get the ball rolling, especially for asking the user what versions of Python/Flask/Flask-RESTPlus are seeing the issue.

Everyone, if you can think of other questions/data that are specific to Flask-RESTPlus that should be part of the issue template since they typically help diagnose the issue, please let me know what they are!

j5awry commented 5 years ago

PR 689 looks good to me. That's the gist of what we end up asking.

slightly off topic, but we should probably do a canned response for PRs as well. The majority we get don't have tests until we ask. It's in the CONTRIBUTING.md, but often overlooked.

JaDogg commented 5 years ago

Yes, having is this unit tested? checkbox in a pull request template is a good idea.

a-luna commented 5 years ago

@JaDogg - Added a PR for a PR template with a checklist that ensures unit tests are passing, PR #702

a-luna commented 5 years ago

@j5awry - Added new commits to PR #697 to include a link to the contributing guidelines doc.