Skip to content

Commit

Permalink
docs: Use GitHub Issue forms as Issue templates (#1576)
Browse files Browse the repository at this point in the history
* Use GitHub Issue form Issue templates to provide more consistent context of requested information from users
   - c.f. 
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms
   - Remove all previous GitHub Issue templates
   - These Issue forms are heavily influenced / copied from Ansible's https://github.com/ansible/ansible/
   - Intentionally add a second space after emojis to have them render better on macOS
* Add config.yml to also link users to GitHub Discussions, the pyhf tutorial, and the Code of Conduct

Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
  • Loading branch information
matthewfeickert and webknjaz authored Sep 2, 2021
1 parent 80a27ac commit 7bf6ed2
Show file tree
Hide file tree
Showing 8 changed files with 296 additions and 70 deletions.
27 changes: 0 additions & 27 deletions .github/ISSUE_TEMPLATE/bug-report.md

This file was deleted.

148 changes: 148 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,148 @@
---
name: 🐛 Bug Report
description: Create a report to help us improve
labels: ["bug", "needs-triage"]

body:
- type: markdown
attributes:
value: >
**Thank you for wanting to report a bug in pyhf!**
Verify first that your issue is not [already reported on
GitHub][issue search].
[issue search]: https://github.com/scikit-hep/pyhf/issues?q=is%3Aopen+is%3Aissue+label%3Abug
- type: textarea
attributes:
label: Summary
description: Explain the problem briefly below.
placeholder: >-
When I try to do X with pyhf and the following workspace, Y breaks or
Z happens in an unexpected manner.
Here are all the details I know about this problem.
validations:
required: true

- type: textarea
attributes:
label: OS / Environment
description: >-
Provide information on your operating system.
Something like the output of `cat /etc/os-release` on Linux or
`system_profiler -detailLevel mini SPSoftwareDataType` on macOS.
render: console
placeholder: |
# Linux
$ cat /etc/os-release
NAME="Ubuntu"
VERSION="20.04.2 LTS (Focal Fossa)"
ID=ubuntu
ID_LIKE=debian
PRETTY_NAME="Ubuntu 20.04.2 LTS"
VERSION_ID="20.04"
HOME_URL="https://www.ubuntu.com/"
SUPPORT_URL="https://help.ubuntu.com/"
BUG_REPORT_URL="https://bugs.launchpad.net/ubuntu/"
PRIVACY_POLICY_URL="https://www.ubuntu.com/legal/terms-and-policies/privacy-policy"
VERSION_CODENAME=focal
UBUNTU_CODENAME=focal
# macOS
$ system_profiler -detailLevel mini SPSoftwareDataType | head -n 6
Software:
System Software Overview:
System Version: macOS 10.15.7 (19H1323)
Kernel Version: Darwin 19.6.0
validations:
required: true

- type: textarea
attributes:
label: Steps to Reproduce
description: >-
Describe exactly how to reproduce the problem, using a minimal test-case.
It would *really* help us understand your problem if you paste in the Python code
that you're running.
**HINT:** You can paste [GitHub Gist](https://gist.github.com) links for larger files.
value: |
<!--- Paste your minimal failing Python example code between the quotes below -->
```python (paste below)
```
<!--- ...or if you have a failing CLI command paste it between the quotes below -->
```console (paste below)
```
validations:
required: true

- type: textarea
attributes:
label: File Upload (optional)
description: >-
If your steps to reproduce your minimal failing example require either a spec or a
workspace file, please upload it by attaching it to the text area here.
**HINT:** You can paste [GitHub Gist](https://gist.github.com) links for larger files.
placeholder: >-
Attach any files or compressed archives by dragging & dropping, selecting,
or pasting them here.
validations:
required: false

- type: textarea
attributes:
label: Expected Results
description: >-
Describe what you expected to happen when running the steps above.
placeholder: >-
I expected X to happen because I assumed Y.
validations:
required: true

- type: textarea
attributes:
label: Actual Results
description: >-
Paste verbatim program or command output.
Don't wrap it with tripple backticks &mdash; your whole input will be
turned into a code snippet automatically.
render: console
validations:
required: true

- type: textarea
attributes:
label: pyhf Version
description: >-
Paste verbatim output from `pyhf --version` below, under the prompt line.
Don't wrap it with tripple backticks &mdash; your whole input will be
turned into a code snippet automatically.
render: console
placeholder: |
$ pyhf --version
validations:
required: true

- type: checkboxes
attributes:
label: Code of Conduct
description: |
Read the [`pyhf` Code of Conduct][CoC] first.
[CoC]: https://github.com/scikit-hep/pyhf/blob/master/CODE_OF_CONDUCT.md
options:
- label: I agree to follow the Code of Conduct
required: true
...
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Ref: https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
blank_issues_enabled: true
contact_links:
- name: 🙋 Useage Questions
url: https://github.com/scikit-hep/pyhf/discussions
about: |
Use pyhf's GitHub Discussions to ask "How do I do X with pyhf?".
- name: 📖 Tutorial
url: https://pyhf.github.io/pyhf-tutorial/
about: |
The pyhf tutorial is continually updated and provides an in depth walkthrough
of how to use the latest release of pyhf.
- name: 📝 pyhf Code of Conduct
url: https://github.com/scikit-hep/pyhf/blob/master/CODE_OF_CONDUCT.md
about: Expectations for how people will interact with each other on pyhf's GitHub.
52 changes: 52 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
name: 📝 Documentation Report
description: Create a report for problems with the docs
labels: ["docs", "needs-triage"]

body:
- type: markdown
attributes:
value: >
**Thank you for wanting to report a problem with pyhf's documentation!**
Verify first that your issue is not [already reported on
GitHub][issue search].
[issue search]: https://github.com/scikit-hep/pyhf/issues?q=is%3Aopen+is%3Aissue+label%3Abug
- type: textarea
attributes:
label: Summary
description: >-
Explain the problem briefly below, add suggestions to wording or structure.
If there are external references that are related please link them here
as well.
placeholder: >-
I was reading the pyhf documentation for pyhf version X and I'm having
problems understanding Y.
It would be very helpful if that got rephrased as Z.
validations:
required: true

- type: input
attributes:
label: Documentation Page Link
description: |
Paste the link to the documentation webpage that you have a question on.
validations:
required: true

- type: checkboxes
attributes:
label: Code of Conduct
description: |
Read the [`pyhf` Code of Conduct][CoC] first.
[CoC]: https://github.com/scikit-hep/pyhf/blob/master/CODE_OF_CONDUCT.md
options:
- label: I agree to follow the Code of Conduct
required: true
...
29 changes: 0 additions & 29 deletions .github/ISSUE_TEMPLATE/feature-request.md

This file was deleted.

80 changes: 80 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
---
name: ✨ Feature Request
description: Suggest an idea for this project
labels: ["feat/enhancement ", "needs-triage"]

body:
- type: markdown
attributes:
value: >
**Thank you for wanting to suggest a feature for pyhf!**
Verify first that your issue is not [already reported on
GitHub][issue search].
Make sure to check the closed issues as well as it may
already be implemented in a development release.
[issue search]: https://github.com/scikit-hep/pyhf/issues?q=is%3Aopen+is%3Aissue+label%3Abug
- type: textarea
attributes:
label: Summary
description: >
Describe the new feature/improvement you would like briefly below.
What's the problem this feature will solve?
What are you trying to do, that you are unable to achieve
with the **latest** release of pyhf?
* Provide examples of real-world use cases that this would enable
and how it solves the problem you described.
* How do you solve this now?
* Have you tried to work around the problem?
* Could there be a different approach to solving this issue?
If there are external references or other GitHub Issues that are related
please link them here as well.
placeholder: >-
I am trying to do X with pyhf version x.y.z and I think that implementing
new feature Y would be very helpful for me and every other user because of Z.
validations:
required: true

- type: textarea
attributes:
label: Additional Information
description: |
If you can, describe how the feature would be used in a mock code example.
**HINT:** You can paste [GitHub Gist](https://gist.github.com) links for larger files.
value: |
<!--- Describe what you are showing in your example -->
<!--- and then paste your mock Python example code between the quotes below -->
```python (paste below)
```
validations:
required: false

- type: checkboxes
attributes:
label: Code of Conduct
description: |
Read the [`pyhf` Code of Conduct][CoC] first.
[CoC]: https://github.com/scikit-hep/pyhf/blob/master/CODE_OF_CONDUCT.md
options:
- label: I agree to follow the Code of Conduct
required: true
...
13 changes: 0 additions & 13 deletions .github/ISSUE_TEMPLATE/question.md

This file was deleted.

2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/~release-checklist.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: (Maintainers Only) Release Checklist
name: Release Checklist (Maintainers Only)
about: Checklist for core developers to complete as part of making a release

---
Expand Down

0 comments on commit 7bf6ed2

Please sign in to comment.