Skip to content

Commit

Permalink
Create bug-report.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
pajod committed Dec 9, 2023
1 parent 26aba9e commit 6501834
Show file tree
Hide file tree
Showing 4 changed files with 95 additions and 1 deletion.
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests
name: Bug Report
description: File a bug report
# could always prepend title, but that leads to odd titles when reporter is unaware
# title: "[Bug]: "
labels: ["- Bugs -"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to report a problem in gunicorn.
As limited time can be spent on triaging reports, we would appreciate if you
* look for existing reports that may match your problem
* include relevant information before anyone even asks
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Also tell us, what did you expect to happen?
placeholder: A python traceback? A HTTP error displayed in the browser?
validations:
required: true
- type: input
attributes:
label: gunicorn version
validations:
required: true
- type: dropdown
id: installation-method
attributes:
label: Installation Method
description: How did you install gunicorn?
options:
- pip (PyPI)
- apt (Debian/Ubuntu)
- Development version from GitHub
- I do not know how to tell.
- Something else
default: 0
validations:
required: true
- type: input
attributes:
label: Python version
description: "If PyPy: please be specific!"
validations:
required: true
9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests

# this is a hack - makes GitHub hide the "no template" button, then we re-add our own
# idea stolen from https://github.com/pypa/pip
blank_issues_enabled: false
contact_links:
- name: "(I know what I am doing) let me file a report without template"
url: "https://github.com/benoitc/gunicorn/issues/new"
about: "It is on you to include every relevant detail."
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests
name: Feature Request
description: Request a new feature or modified default behaviour
# could always prepend title, but that leads to odd titles when reporter is unaware
# title: "[FR]: "
# title: "[RFF]: "
# need to cleanup existing labels before adding this
# labels: ["- Features -"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to suggest improvements for Gunicorn.
As limited time can be spent on triaging, we would appreciate if you
* look for existing requests that may match yours
* include in your report considerations about not breaking existing functionality
* include in your report considerations about maintaining the feature
- type: textarea
id: what-problem
attributes:
label: What problem would like like to see solved
description: How is what you want to do not currently easily achieved with gunicorn?
placeholder: I would like to do X, which is currently not supported on Y.
validations:
required: true
- type: textarea
id: proposed-solution
attributes:
label: How would you like to see the problem solved
description: Please be specific. Explicitly mention what existing functionality might be impacted.
placeholder: I would modify the X component to accept Y also for in the Z case. The B case for Y will remain untouched. The A case will stop working, but that could have never worked due to C anyway.
9 changes: 8 additions & 1 deletion .github/workflows/tox.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
name: tox
on: [push, pull_request]
on:
push:
paths-ignore:
- ".github/ISSUE_TEMPLATE/**"
pull_request:
paths-ignore:
- ".github/ISSUE_TEMPLATE/**"

permissions:
contents: read # to fetch code (actions/checkout)
jobs:
Expand Down

0 comments on commit 6501834

Please sign in to comment.