diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index f65e341155..0000000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -name: Bug Report -about: Create a report to help us improve - ---- - -# Description - -Describe your bug here - -# Expected Behavior - -Describe what you thought should have happened - -# Actual Behavior - -Describe what did happen - -# Steps to Reproduce - -Detail your environment and `pyhf.__version__` and the commands that you are executing to generate the bug. If you have a large program please make a [Gist](https://gist.github.com/) and link it here. Additionally attach any screen shots as needed. - -# Checklist - -- [ ] Run `git fetch` to get the most up to date version of `master` -- [ ] Searched through existing Issues to confirm this is not a duplicate issue -- [ ] Filled out the Description, Expected Behavior, Actual Behavior, and Steps to Reproduce sections above or have edited/removed them in a way that fully describes the issue diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000000..fff0bdc5aa --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -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: | + + ```python (paste 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 — 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 — 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 +... diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..6521ee043b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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. diff --git a/.github/ISSUE_TEMPLATE/documentation-report.yml b/.github/ISSUE_TEMPLATE/documentation-report.yml new file mode 100644 index 0000000000..2c023c969c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation-report.yml @@ -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 +... diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md deleted file mode 100644 index 1c27669bd2..0000000000 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -name: Feature Request -about: Suggest an idea for this project - ---- - -# Description - -Describe the feature you would like to be added and its use. Please give a clear and concise description. - -## Is your feature request related to a problem? Please describe. -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -### Describe the solution you'd like -A clear and concise description of what you want to happen. - -### Describe alternatives you've considered -A clear and concise description of any alternative solutions or features you've considered. - -# Relevant Issues and Pull Requests - -If there are relevant issues and pull requests for this feature please list and link them here - -- Issue A -- Issue B -- PR A - -# Additional context -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 0000000000..1d1dc79620 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -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: | + + + + ```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 +... diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md deleted file mode 100644 index 7ce3e57dc2..0000000000 --- a/.github/ISSUE_TEMPLATE/question.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -name: Question -about: Discuss an idea to see if it would be an appropriate Issue - ---- - -# Question - -What is the question that you have? Please be detailed and give examples. - -# Relevant Issues and Pull Requests - -If there are relevant issues and pull requests for this feature please list and link them here diff --git a/.github/ISSUE_TEMPLATE/~release-checklist.md b/.github/ISSUE_TEMPLATE/~release-checklist.md index 5db6a5bab2..1d4c74ecc0 100644 --- a/.github/ISSUE_TEMPLATE/~release-checklist.md +++ b/.github/ISSUE_TEMPLATE/~release-checklist.md @@ -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 ---