diff options
| author | Pradyun Gedam <pradyunsg@gmail.com> | 2018-05-07 13:49:45 +0530 |
|---|---|---|
| committer | Pradyun Gedam <pradyunsg@gmail.com> | 2018-05-27 15:53:31 +0530 |
| commit | c70856d14267f6949f01c2a6100670d00c60fe1d (patch) | |
| tree | 1b0fbb4f732cf20a9efc5a24a1f72050fb96bdd6 | |
| parent | 61b011293b036330b56ba87a75aa4c330ab03b2d (diff) | |
| download | pip-issue-templates.tar.gz | |
Update to use new GitHub support for issue templatesissue-templates
https://blog.github.com/2018-05-02-issue-template-improvements/
- Create new, dedicated issue templates for:
- bug reports
- feature requests
- @pypa/pip-committers Any other kind of template we might want to add to this list?
- Improve bug report template to include steps to reproduce
- Slightly smaller headings
| -rw-r--r-- | .github/ISSUE_TEMPLATE/Bug_report.md | 33 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/Feature_request.md | 21 |
2 files changed, 54 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md new file mode 100644 index 000000000..07acb4a9a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Bug_report.md @@ -0,0 +1,33 @@ +---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+#### Environment Information
+
+* pip version:
+* Python version:
+* OS:
+
+#### Describe the bug
+
+A clear and concise description of what the bug is; what you were trying, what happened, what went wrong and so on. Provide any context that you feel is helpful here.
+
+#### How to Reproduce
+
+Describe what steps need to be followed to bump into this bug.
+
+1. Run '...'
+2. Then run '...'
+3. See error
+
+#### Output
+
+```
+Paste the output of the steps above, including the commands themselves and pip's output/traceback etc.
+```
+
+#### Expected behavior
+
+A clear and concise description of what you expected to happen.
diff --git a/.github/ISSUE_TEMPLATE/Feature_request.md b/.github/ISSUE_TEMPLATE/Feature_request.md new file mode 100644 index 000000000..651d40732 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Feature_request.md @@ -0,0 +1,21 @@ +---
+name: Feature request
+about: Suggest an idea for this project
+
+---
+
+#### Is your feature request related to a problem? Please describe.
+
+A clear and concise description of what the problem is.
+
+#### Describe the solution you'd like
+
+A clear and concise description of what you want to happen. If it's possible to achieve this today, also describe how this solution is compared to the status quo.
+
+#### Describe alternatives you've considered
+
+A clear and concise description of any alternative solutions or features you've considered.
+
+#### Additional context
+
+Add any other context or details, related to the feature request here.
|