From bd527ff55795684de21ef798ce16c6b03ee66acb Mon Sep 17 00:00:00 2001 From: Andy Kee Date: Tue, 17 Oct 2023 20:35:11 -0700 Subject: [PATCH] GitHub issue templates --- .github/ISSUE_TEMPLATE/bug-report.yml | 38 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/documentation.yml | 20 ++++++++++++ .github/ISSUE_TEMPLATE/feature-request.yml | 11 +++++++ 3 files changed, 69 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/documentation.yml create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000..409b8f5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,38 @@ +name: Bug report +description: Report a bug. +title: "BUG: " +labels: [bug] + +body: +- type: textarea + attributes: + label: "Describe the issue:" + validations: + required: true + +- type: textarea + attributes: + label: "Reproduce the code example:" + description: > + A short code example that reproduces the problem/missing feature. It + should be self-contained, i.e., can be copy-pasted into the Python + interpreter or run as-is via `python myproblem.py`. + render: python + validations: + required: true + +- type: textarea + attributes: + label: "Error message:" + description: > + Please include full error message, if any. + render: shell + +- type: textarea + attributes: + label: "Runtime information:" + description: > + Output from `import sys, lentil, numpy, scipy; print(lentil.__version__); print(numpy.__version__); print(scipy.__version__); print(sys.version)` + render: shell + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 0000000..4863aa5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -0,0 +1,20 @@ +name: Documentation +description: Report an issue related to the documentation. +title: "DOC: " +labels: [doc] + +body: +- type: textarea + attributes: + label: "Issue with current documentation:" + description: > + Please make sure to leave a reference to the document/code you're + referring to. + +- type: textarea + attributes: + label: "Idea or request for content:" + description: > + Please describe as clearly as possible a suggested fix, better + phrasing or topics you think are missing from the current + documentation. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 0000000..162cec2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,11 @@ +name: Feature request +description: Suggest an idea. +title: "ENH: " +labels: [enh] + +body: +- type: textarea + attributes: + label: "Proposed new feature or change:" + validations: + required: true \ No newline at end of file