Skip to content

Commit 1dfadb7

Browse files
authored
Update bug_report.md
1 parent 99aadcb commit 1dfadb7

File tree

1 file changed

+68
-27
lines changed

1 file changed

+68
-27
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+68-27
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,71 @@
1-
---
2-
name: Bug report
3-
about: Create a report to help us improve
4-
title: ''
5-
labels: bug
6-
assignees: amilworks
1+
name: Bug Report
2+
description: Report a bug to help us improve
3+
title: "Bug: "
4+
labels: [bug]
75

8-
---
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: >
10+
11+
Thank you for opening this issue!
912

10-
**Describe the bug**
11-
A clear and concise description of what the bug is.
13+
If you're new to CellGeometry, consider the following options first:
1214

13-
**To Reproduce**
14-
Steps to reproduce the behavior:
15-
1. Go to '...'
16-
2. Click on '....'
17-
3. Scroll down to '....'
18-
4. See error
19-
20-
**Expected behavior**
21-
A clear and concise description of what you expected to happen.
22-
23-
**Screenshots**
24-
If applicable, add screenshots to help explain your problem.
25-
26-
**Desktop (please complete the following information):**
27-
- OS: [e.g. Ubuntu]
28-
29-
**Additional context**
30-
Add any other context about the problem here.
15+
- reading the CellGeometry documentation: https://bioshapelab.github.io/cellGeometry
16+
- searching our existing issue tracker for a similar issue (https://github.com/bioshapelab/CellGeometry/issues) to see if
17+
your problem has already been reported.
18+
19+
- type: textarea
20+
attributes:
21+
label: Describe the bug
22+
description: |
23+
A clear and concise description of the bug.
24+
validations:
25+
required: false
26+
- type: textarea
27+
attributes:
28+
label: Steps/Code to Reproduce
29+
description: |
30+
Describe clearly and concisely the steps to ensure that it can be reproduced and potentially fixed:
31+
- Any commands you ran
32+
- What module is affected if you know
33+
- Include a minimal, reproducible example (https://stackoverflow.com/help/minimal-reproducible-example), if possible.
34+
placeholder: |
35+
```
36+
Sample code to reproduce the problem
37+
```
38+
validations:
39+
required: true
40+
- type: textarea
41+
attributes:
42+
label: Expected Behaviour
43+
description: >
44+
A clear and concise description of what you expected to happen.
45+
placeholder: >
46+
Example: No error is thrown.
47+
validations:
48+
required: true
49+
- type: textarea
50+
attributes:
51+
label: Actual Behaviour
52+
description: |
53+
Please paste or describe the results you observe instead of the expected behaviour.
54+
If you observe an error, please paste the error message including the **full traceback** of the exception.
55+
placeholder: >
56+
Please paste or specifically describe the actual output or traceback.
57+
validations:
58+
required: true
59+
- type: textarea
60+
attributes:
61+
label: Your environment
62+
render: shell
63+
description: |
64+
- CellGeometry version tested on:
65+
- Operating system and architecture:
66+
validations:
67+
required: true
68+
- type: markdown
69+
attributes:
70+
value: >
71+
Thanks for contributing 🎉!

0 commit comments

Comments
 (0)