Skip to content

Commit

Permalink
Update GitHub templates with new forms (#1280)
Browse files Browse the repository at this point in the history
  • Loading branch information
Kludex committed Dec 6, 2021
1 parent ecd2cc7 commit 63a10e5
Show file tree
Hide file tree
Showing 4 changed files with 111 additions and 86 deletions.
53 changes: 0 additions & 53 deletions .github/ISSUE_TEMPLATE/2-bug-report.md

This file was deleted.

33 changes: 0 additions & 33 deletions .github/ISSUE_TEMPLATE/3-feature-request.md

This file was deleted.

75 changes: 75 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
name: Bug report
description: Report a bug to help improve this project
body:
- type: checkboxes
id: checks
attributes:
label: Checklist
description: Please make sure you check all these items before submitting your bug report.
options:
- label: The bug is reproducible against the latest release or `master`.
required: true
- label: There are no similar issues or pull requests to fix it yet.
required: true
- type: textarea
id: describe
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is.
validations:
required: true
- type: textarea
id: steps
attributes:
label: Steps to reproduce the bug
description: |
Provide a *minimal* example with steps to reproduce the bug locally.
NOTE: try to keep any external dependencies *at an absolute minimum*.
In other words, remove anything that doesn't make the bug go away.
validations:
required: false
- type: textarea
id: expected
attributes:
label: Expected behavior
description: A clear and concise description of what you expected to happen.
validations:
required: false
- type: textarea
id: actual
attributes:
label: Actual behavior
description: A clear and concise description of what actually happened.
validations:
required: false
- type: textarea
id: notes
attributes:
label: Debugging material
description: |
Any tracebacks, screenshots, etc. that can help understanding the problem.
NOTE:
- Please list tracebacks in full (don't truncate them).
- If relevant, consider turning on DEBUG or TRACE logs for additional details (see the Logging section on https://www.uvicorn.org/settings/ specifically the `log-level` flag).
- Consider using `<details>` to make tracebacks/logs collapsible if they're very large (see https://gist.github.com/ericclemmons/b146fe5da72ca1f706b2ef72a20ac39d).
validations:
required: false
- type: textarea
id: environment
attributes:
label: Environment
description: Describe your environment.
placeholder: |
- OS / Python / Uvicorn version: just run `uvicorn --version`
- The exact command you're running uvicorn with, all flags you passed included. If you run it with gunicorn please do the same. If there is a reverse-proxy involved and you cannot reproduce without it please give the minimal config of it to reproduce.
validations:
required: true
- type: textarea
id: additional
attributes:
label: Additional context
description: |
Any additional information that can help understanding the problem.
Eg. linked issues, or a description of what you were trying to achieve.
validations:
required: false
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: Feature Request
description: Suggest an idea for a feature that you would like to see in uvicorn
body:
- type: checkboxes
id: checks
attributes:
label: Checklist
description: Please make sure you check all these items before submitting your feature request.
options:
- label: There are no similar issues or pull requests for this yet.
required: true
- label: I discussed this idea on the [community chat](https://gitter.im/encode/community) and feedback is positive.
required: true
- type: textarea
id: problem
attributes:
label: Is your feature related to a problem? Please describe.
description: A clear and concise description of what you are trying to achieve.
placeholder: I want to be able to [...] but I can't because [...]
- type: textarea
id: solution
attributes:
label: Describe the solution you would like.
description: |
A clear and concise description of what you would want to happen.
For API changes, try to provide a code snippet of what you would like the API to look like.
- type: textarea
id: alternatives
attributes:
label: Describe alternatives you considered
description: Please describe any alternative solutions or features you've considered to solve your problem and why they wouldn't solve it.
- type: textarea
id: additional
attributes:
label: Additional context
description: Provide any additional context, screenshots, trace backs, etc. about the feature here.

0 comments on commit 63a10e5

Please sign in to comment.