Skip to content

Commit 7bf6ed2

Browse files
matthewfeickertwebknjaz
matthewfeickert
and
webknjaz
authored
docs: Use GitHub Issue forms as Issue templates (#1576)
* 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>
1 parent 80a27ac commit 7bf6ed2

8 files changed

+296
-70
lines changed

‎.github/ISSUE_TEMPLATE/bug-report.md

-27
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug-report.yml

+148
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
1+
---
2+
name: 🐛 Bug Report
3+
description: Create a report to help us improve
4+
labels: ["bug", "needs-triage"]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: >
10+
**Thank you for wanting to report a bug in pyhf!**
11+
12+
13+
⚠
14+
Verify first that your issue is not [already reported on
15+
GitHub][issue search].
16+
17+
18+
[issue search]: https://github.com/scikit-hep/pyhf/issues?q=is%3Aopen+is%3Aissue+label%3Abug
19+
20+
- type: textarea
21+
attributes:
22+
label: Summary
23+
description: Explain the problem briefly below.
24+
placeholder: >-
25+
When I try to do X with pyhf and the following workspace, Y breaks or
26+
Z happens in an unexpected manner.
27+
Here are all the details I know about this problem.
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
attributes:
33+
label: OS / Environment
34+
description: >-
35+
Provide information on your operating system.
36+
Something like the output of `cat /etc/os-release` on Linux or
37+
`system_profiler -detailLevel mini SPSoftwareDataType` on macOS.
38+
render: console
39+
placeholder: |
40+
# Linux
41+
$ cat /etc/os-release
42+
NAME="Ubuntu"
43+
VERSION="20.04.2 LTS (Focal Fossa)"
44+
ID=ubuntu
45+
ID_LIKE=debian
46+
PRETTY_NAME="Ubuntu 20.04.2 LTS"
47+
VERSION_ID="20.04"
48+
HOME_URL="https://www.ubuntu.com/"
49+
SUPPORT_URL="https://help.ubuntu.com/"
50+
BUG_REPORT_URL="https://bugs.launchpad.net/ubuntu/"
51+
PRIVACY_POLICY_URL="https://www.ubuntu.com/legal/terms-and-policies/privacy-policy"
52+
VERSION_CODENAME=focal
53+
UBUNTU_CODENAME=focal
54+
55+
# macOS
56+
$ system_profiler -detailLevel mini SPSoftwareDataType | head -n 6
57+
Software:
58+
59+
System Software Overview:
60+
61+
System Version: macOS 10.15.7 (19H1323)
62+
Kernel Version: Darwin 19.6.0
63+
validations:
64+
required: true
65+
66+
- type: textarea
67+
attributes:
68+
label: Steps to Reproduce
69+
description: >-
70+
Describe exactly how to reproduce the problem, using a minimal test-case.
71+
It would *really* help us understand your problem if you paste in the Python code
72+
that you're running.
73+
74+
75+
**HINT:** You can paste [GitHub Gist](https://gist.github.com) links for larger files.
76+
value: |
77+
<!--- Paste your minimal failing Python example code between the quotes below -->
78+
```python (paste below)
79+
80+
```
81+
82+
<!--- ...or if you have a failing CLI command paste it between the quotes below -->
83+
```console (paste below)
84+
85+
```
86+
validations:
87+
required: true
88+
89+
- type: textarea
90+
attributes:
91+
label: File Upload (optional)
92+
description: >-
93+
If your steps to reproduce your minimal failing example require either a spec or a
94+
workspace file, please upload it by attaching it to the text area here.
95+
96+
97+
**HINT:** You can paste [GitHub Gist](https://gist.github.com) links for larger files.
98+
placeholder: >-
99+
Attach any files or compressed archives by dragging & dropping, selecting,
100+
or pasting them here.
101+
validations:
102+
required: false
103+
104+
- type: textarea
105+
attributes:
106+
label: Expected Results
107+
description: >-
108+
Describe what you expected to happen when running the steps above.
109+
placeholder: >-
110+
I expected X to happen because I assumed Y.
111+
validations:
112+
required: true
113+
114+
- type: textarea
115+
attributes:
116+
label: Actual Results
117+
description: >-
118+
Paste verbatim program or command output.
119+
Don't wrap it with tripple backticks &mdash; your whole input will be
120+
turned into a code snippet automatically.
121+
render: console
122+
validations:
123+
required: true
124+
125+
- type: textarea
126+
attributes:
127+
label: pyhf Version
128+
description: >-
129+
Paste verbatim output from `pyhf --version` below, under the prompt line.
130+
Don't wrap it with tripple backticks &mdash; your whole input will be
131+
turned into a code snippet automatically.
132+
render: console
133+
placeholder: |
134+
$ pyhf --version
135+
validations:
136+
required: true
137+
138+
- type: checkboxes
139+
attributes:
140+
label: Code of Conduct
141+
description: |
142+
Read the [`pyhf` Code of Conduct][CoC] first.
143+
144+
[CoC]: https://github.com/scikit-hep/pyhf/blob/master/CODE_OF_CONDUCT.md
145+
options:
146+
- label: I agree to follow the Code of Conduct
147+
required: true
148+
...

‎.github/ISSUE_TEMPLATE/config.yml

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Ref: https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
2+
blank_issues_enabled: true
3+
contact_links:
4+
- name: 🙋 Useage Questions
5+
url: https://github.com/scikit-hep/pyhf/discussions
6+
about: |
7+
Use pyhf's GitHub Discussions to ask "How do I do X with pyhf?".
8+
- name: 📖 Tutorial
9+
url: https://pyhf.github.io/pyhf-tutorial/
10+
about: |
11+
The pyhf tutorial is continually updated and provides an in depth walkthrough
12+
of how to use the latest release of pyhf.
13+
- name: 📝 pyhf Code of Conduct
14+
url: https://github.com/scikit-hep/pyhf/blob/master/CODE_OF_CONDUCT.md
15+
about: Expectations for how people will interact with each other on pyhf's GitHub.

‎.github/ISSUE_TEMPLATE/documentation-report.yml

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
name: 📝 Documentation Report
3+
description: Create a report for problems with the docs
4+
labels: ["docs", "needs-triage"]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: >
10+
**Thank you for wanting to report a problem with pyhf's documentation!**
11+
12+
13+
⚠
14+
Verify first that your issue is not [already reported on
15+
GitHub][issue search].
16+
17+
18+
[issue search]: https://github.com/scikit-hep/pyhf/issues?q=is%3Aopen+is%3Aissue+label%3Abug
19+
20+
- type: textarea
21+
attributes:
22+
label: Summary
23+
description: >-
24+
Explain the problem briefly below, add suggestions to wording or structure.
25+
If there are external references that are related please link them here
26+
as well.
27+
placeholder: >-
28+
I was reading the pyhf documentation for pyhf version X and I'm having
29+
problems understanding Y.
30+
It would be very helpful if that got rephrased as Z.
31+
validations:
32+
required: true
33+
34+
- type: input
35+
attributes:
36+
label: Documentation Page Link
37+
description: |
38+
Paste the link to the documentation webpage that you have a question on.
39+
validations:
40+
required: true
41+
42+
- type: checkboxes
43+
attributes:
44+
label: Code of Conduct
45+
description: |
46+
Read the [`pyhf` Code of Conduct][CoC] first.
47+
48+
[CoC]: https://github.com/scikit-hep/pyhf/blob/master/CODE_OF_CONDUCT.md
49+
options:
50+
- label: I agree to follow the Code of Conduct
51+
required: true
52+
...

‎.github/ISSUE_TEMPLATE/feature-request.md

-29
This file was deleted.

‎.github/ISSUE_TEMPLATE/feature-request.yml

+80
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
---
2+
name: ✨ Feature Request
3+
description: Suggest an idea for this project
4+
labels: ["feat/enhancement ", "needs-triage"]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: >
10+
**Thank you for wanting to suggest a feature for pyhf!**
11+
12+
13+
⚠
14+
Verify first that your issue is not [already reported on
15+
GitHub][issue search].
16+
Make sure to check the closed issues as well as it may
17+
already be implemented in a development release.
18+
19+
20+
[issue search]: https://github.com/scikit-hep/pyhf/issues?q=is%3Aopen+is%3Aissue+label%3Abug
21+
22+
23+
- type: textarea
24+
attributes:
25+
label: Summary
26+
description: >
27+
Describe the new feature/improvement you would like briefly below.
28+
29+
30+
What's the problem this feature will solve?
31+
What are you trying to do, that you are unable to achieve
32+
with the **latest** release of pyhf?
33+
34+
35+
* Provide examples of real-world use cases that this would enable
36+
and how it solves the problem you described.
37+
38+
* How do you solve this now?
39+
40+
* Have you tried to work around the problem?
41+
42+
* Could there be a different approach to solving this issue?
43+
44+
45+
If there are external references or other GitHub Issues that are related
46+
please link them here as well.
47+
placeholder: >-
48+
I am trying to do X with pyhf version x.y.z and I think that implementing
49+
new feature Y would be very helpful for me and every other user because of Z.
50+
validations:
51+
required: true
52+
53+
- type: textarea
54+
attributes:
55+
label: Additional Information
56+
description: |
57+
If you can, describe how the feature would be used in a mock code example.
58+
59+
**HINT:** You can paste [GitHub Gist](https://gist.github.com) links for larger files.
60+
value: |
61+
<!--- Describe what you are showing in your example -->
62+
63+
<!--- and then paste your mock Python example code between the quotes below -->
64+
```python (paste below)
65+
66+
```
67+
validations:
68+
required: false
69+
70+
- type: checkboxes
71+
attributes:
72+
label: Code of Conduct
73+
description: |
74+
Read the [`pyhf` Code of Conduct][CoC] first.
75+
76+
[CoC]: https://github.com/scikit-hep/pyhf/blob/master/CODE_OF_CONDUCT.md
77+
options:
78+
- label: I agree to follow the Code of Conduct
79+
required: true
80+
...

‎.github/ISSUE_TEMPLATE/question.md

-13
This file was deleted.

‎.github/ISSUE_TEMPLATE/~release-checklist.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
name: (Maintainers Only) Release Checklist
2+
name: ✅ Release Checklist (Maintainers Only)
33
about: Checklist for core developers to complete as part of making a release
44

55
---

0 commit comments

Comments
 (0)