Skip to content

Commit 901dba7

Browse files
TimMonkoTimMonko
authored
add github templates (#183)
1 parent 1de11fa commit 901dba7

File tree

5 files changed

+148
-0
lines changed

5 files changed

+148
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
name: "\U0001F41B Bug Report"
2+
description: Report a bug encountered while using napari-ndev
3+
labels:
4+
- "bug"
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for taking the time to report this issue! 🙏🏼
11+
12+
Please fill out the sections below to help us reproduce the problem.
13+
14+
- type: textarea
15+
id: bug-report
16+
attributes:
17+
label: "\U0001F41B Bug Report"
18+
description: "Please provide a clear and concise description of the bug."
19+
placeholder: "What went wrong? What did you expect to happen?"
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: steps-to-reproduce
25+
attributes:
26+
label: "\U0001F4A1 Steps to Reproduce"
27+
description: "Please provide a minimal code snippet or list of steps to reproduce the bug."
28+
placeholder: |
29+
1. Go to '...'
30+
2. Click on '....'
31+
3. Scroll down to '....'
32+
4. See error
33+
validations:
34+
required: true
35+
36+
- type: textarea
37+
id: expected-behavior
38+
attributes:
39+
label: "\U0001F4A1 Expected Behavior"
40+
description: "Please provide a clear and concise description of what you expected to happen."
41+
placeholder: "What did you expect to happen?"
42+
43+
- type: textarea
44+
id: environment
45+
attributes:
46+
label: "\U0001F30E Environment"
47+
description: |
48+
Please provide detailed information regarding your environment. Please paste the output of `napari --info` here or copy the information from the "napari info" dialog in the napari Help menu.
49+
50+
Otherwise, please provide information regarding your operating system (OS), Python version, napari version, Qt backend and version, Qt platform, method of installation, and any other relevant information related to your environment.
51+
52+
53+
placeholder: |
54+
napari: 0.5.0
55+
Platform: macOS-13.2.1-arm64-arm-64bit
56+
System: MacOS 13.2.1
57+
Python: 3.11.4 (main, Aug 7 2023, 20:34:01) [Clang 14.0.3 (clang-1403.0.22.14.1)]
58+
Qt: 5.15.10
59+
PyQt5: 5.15.10
60+
NumPy: 1.25.1
61+
SciPy: 1.11.1
62+
Dask: 2023.7.1
63+
VisPy: 0.13.0
64+
magicgui: 0.7.2
65+
superqt: 0.5.4
66+
in-n-out: 0.1.8
67+
app-model: 0.2.0
68+
npe2: 0.7.2
69+
70+
OpenGL:
71+
- GL version: 2.1 Metal - 83
72+
- MAX_TEXTURE_SIZE: 16384
73+
74+
Screens:
75+
- screen 1: resolution 1512x982, scale 2.0
76+
77+
Settings path:
78+
- /Users/.../napari/napari_5c6993c40c104085444cfc0c77fa392cb5cb8f56/settings.yaml
79+
validations:
80+
required: true
81+
82+
- type: textarea
83+
id: additional-context
84+
attributes:
85+
label: "\U0001F4A1 Additional Context"
86+
description: "Please provide any additional information or context regarding the problem here."
87+
placeholder: "Add any other context about the problem here."

‎.github/ISSUE_TEMPLATE/documentation.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
name: "\U0001F4DA Documentation"
3+
about: Report an issue with napari-ndev documentation
4+
title: ''
5+
labels: documentation
6+
assignees: ''
7+
8+
---
9+
10+
## 📚 Documentation
11+
<!-- A clear and concise description of the documentation that needs to be created/updated -->

‎.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: "\U0001F680 Feature Request"
3+
about: Submit a proposal/request for a new napari-ndev feature
4+
title: ''
5+
labels: feature
6+
assignees: ''
7+
8+
---
9+
10+
## 🚀 Feature
11+
<!-- A clear and concise description of the feature proposal -->
12+
13+
## Motivation
14+
15+
<!-- Please outline the motivation for the proposal. Is your feature request related to a problem? e.g., I'm always frustrated when [...]. If this is related to another GitHub issue, please link here too -->
16+
17+
## Pitch
18+
19+
<!-- A clear and concise description of what you want to happen. -->
20+
21+
## Alternatives
22+
23+
<!-- A clear and concise description of any alternative solutions or features you've considered, if any. -->
24+
25+
## Additional context
26+
27+
<!-- Add any other context or screenshots about the feature request here. -->

‎.github/ISSUE_TEMPLATE/task.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
name: "\U0001F9F0 Task"
3+
about: Maintenance, follow-ups, and other defined to-do items
4+
title: ''
5+
labels: task
6+
assignees: ''
7+
8+
---
9+
10+
## 🧰 Task
11+
<!-- A clear and concise description of the task -->

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# References and relevant issues
2+
<!-- What relevant resources were used in the creation of this PR?
3+
If this PR addresses an existing issue on the repo,
4+
please link to that issue here as "Closes #(issue-number)"
5+
If this PR depends on another PR/issue (even in another repo),
6+
please link to it with "Depends on #PR-number" or "Depends on org/repo#PR-number"
7+
-->
8+
9+
# Description
10+
<!-- What does this pull request (PR) do? Is it a new feature, a bug fix,
11+
an improvement, or something else? Why is it necessary? If relevant, please add
12+
a screenshot or a screen capture: "An image is worth a thousand words!" -->

0 commit comments

Comments
 (0)