Skip to content

Commit 00498fe

Browse files
committed
Add initial bug & feature request templates for Issues.
1 parent 0b30311 commit 00498fe

3 files changed

Lines changed: 114 additions & 0 deletions

File tree

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
name: 🐛 Bug Report
2+
description: File a bug report to help us improve NEMO Cookbook.
3+
labels: [bug, "needs triage"]
4+
body:
5+
- type: textarea
6+
id: what-happened
7+
attributes:
8+
label: What happened?
9+
description: |
10+
Thanks for reporting a bug! Please provide a concise description of what happened.
11+
validations:
12+
required: true
13+
14+
- type: textarea
15+
id: what-did-you-expect-to-happen
16+
attributes:
17+
label: What did you expect to happen?
18+
description: |
19+
Describe what you expected to happen.
20+
validations:
21+
required: false
22+
23+
- type: textarea
24+
id: reproduce
25+
attributes:
26+
label: Steps to Reproduce
27+
description: Provide a minimal, self-contained copy-pastable example that demonstrates the issue.
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
id: log-output
33+
attributes:
34+
label: Relevant Log Output
35+
description: Copy and paste any relevant output. This will be automatically formatted into code, so no need for markdown backticks.
36+
render: Python
37+
validations:
38+
required: true
39+
40+
- type: dropdown
41+
id: python-version
42+
attributes:
43+
label: Python Version
44+
options:
45+
- "3.9"
46+
- "3.10"
47+
- "3.11"
48+
- "3.12"
49+
- "3.13"
50+
validations:
51+
required: true
52+
53+
- type: textarea
54+
id: show-versions
55+
attributes:
56+
label: Environment
57+
description: |
58+
Include the OS, installation method, and relevant dependencies including the output of `xr.show_versions()`.
59+
placeholder: |
60+
OS: Linux / macOS / Windows
61+
Install: pip / conda / source
62+
...
63+
validations:
64+
required: true
65+
66+
- type: textarea
67+
id: extra
68+
attributes:
69+
label: Anything else we need to know?
70+
description: |
71+
Please include any other information you want to share.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: ❓ Usage Question
4+
url: https://github.com/NOC-MSM/nemo_cookbook/discussions
5+
about: |
6+
Ask questions and share ideas with other NEMO Cookbook community members here.
7+
If you have a question like "How do I calculate eddy kinetic energy?" then
8+
please include a self-contained, reproducible example if possible.
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: 💡 Feature Request
2+
description: Suggest an idea for a new NEMO Cookbook feature.
3+
labels: [enhancement]
4+
body:
5+
- type: textarea
6+
id: description
7+
attributes:
8+
label: Is your feature request related to a problem?
9+
description: |
10+
Please search our existing issues to make sure that this feature has not been requested previously.
11+
Please provide a clear and concise description of the problem you would like to solve.
12+
validations:
13+
required: true
14+
- type: textarea
15+
id: solution
16+
attributes:
17+
label: Describe the solution you'd like...
18+
description: |
19+
A clear and concise description of the behavior you would like to implement.
20+
- type: textarea
21+
id: alternatives
22+
attributes:
23+
label: Describe any alternatives you've considered...
24+
description: |
25+
A clear and concise description of alternative solutions or features you've already considered.
26+
validations:
27+
required: false
28+
- type: textarea
29+
id: additional-context
30+
attributes:
31+
label: Additional context
32+
description: |
33+
Add any other context about the feature request here.
34+
validations:
35+
required: false

0 commit comments

Comments
 (0)