Skip to content

Commit

Permalink
GitHub issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
andykee committed Oct 18, 2023
1 parent ec4ffaf commit bd527ff
Show file tree
Hide file tree
Showing 3 changed files with 69 additions and 0 deletions.
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Bug report
description: Report a bug.
title: "BUG: <Please write a title after the 'BUG: ' prefix>"
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
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: Documentation
description: Report an issue related to the documentation.
title: "DOC: <Please write a title after the 'DOC: ' prefix>"
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.
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
name: Feature request
description: Suggest an idea.
title: "ENH: <Please write a title after the 'ENH: ' prefix>"
labels: [enh]

body:
- type: textarea
attributes:
label: "Proposed new feature or change:"
validations:
required: true

0 comments on commit bd527ff

Please sign in to comment.