Skip to content

Commit f803cbe

Browse files
harryswift01harryswift01
authored
Merge pull request #46 from CCPBioSim/45-introduce-github-issue-picker
Enable Issue Template Picker by Adding Templates and Adding Configuration File
2 parents 2e4d0d9 + 28758a8 commit f803cbe

6 files changed

Lines changed: 131 additions & 47 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 57 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,70 @@
11
---
22
name: Bug report
33
about: Create a report to help us improve
4-
title: ''
5-
labels: ''
4+
title: '[Bug]: '
5+
labels: bug
66
assignees: ''
77

88
---
99

10-
**Describe the bug**
11-
A clear and concise description of what the bug is.
10+
# Bug Report
11+
<!-- A clear and concise description of the issue. -->
1212

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
13+
---
14+
15+
## To Reproduce
16+
<!-- Provide the YAML configuration and the exact CLI command that reproduces the issue. -->
17+
18+
### YAML configuration
19+
<!-- Paste the YAML file or the smallest excerpt that reproduces the issue.
20+
Remove unrelated fields to make it minimal. -->
21+
```yaml
22+
# Paste the YAML snippet here
23+
```
24+
25+
### CLI command used
26+
<!-- Write the exact command used, for example: -->
27+
```bash
28+
# Paste the CLI command here
29+
```
30+
31+
### Actual output
32+
<!-- Paste the output, logs, or error messages here -->
33+
```bash
34+
# Paste the output, logs, or error messages here
35+
```
36+
37+
### Expected output
38+
<!-- Describe what you expected to see instead -->
39+
40+
---
1941

20-
**Expected behavior**
21-
A clear and concise description of what you expected to happen.
42+
## Environment and Versions
2243

23-
**Screenshots**
24-
If applicable, add screenshots to help explain your problem.
44+
- Operating System:
45+
- Package Version:
46+
- Python Version:
47+
- Package list:
48+
- If using conda, run: `conda list > packages.txt` and paste the contents here.
2549

26-
**Desktop (please complete the following information):**
27-
- OS: [e.g. iOS]
28-
- Browser [e.g. chrome, safari]
29-
- Version [e.g. 22]
50+
``` bash
51+
# Paste packages.txt here
52+
```
53+
54+
- If using venv/pip, run: `pip list > packages.txt` and paste the contents here.
55+
56+
``` bash
57+
# Paste packages.txt here
58+
```
59+
60+
---
61+
62+
## Screenshots or Logs
63+
64+
<!-- Attach any relevant screenshots, logs, or stack traces. -->
65+
66+
---
3067

31-
**Smartphone (please complete the following information):**
32-
- Device: [e.g. iPhone6]
33-
- OS: [e.g. iOS8.1]
34-
- Browser [e.g. stock browser, safari]
35-
- Version [e.g. 22]
68+
## Additional Context
3669

37-
**Additional context**
38-
Add any other context about the problem here.
70+
<!-- Include anything else that might help reproduce or understand the bug, such as changes from a previously working version. -->

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
blank_issues_enabled: false
2+
issue_templates:
3+
- name: "Bug Report"
4+
description: "Report a bug."
5+
title: "[Bug]: "
6+
labels: ["bug"]
7+
body: "./ISSUE_TEMPLATE/bug_report.md"
8+
- name: "Feature Request"
9+
description: "Propose a new feature or improvement."
10+
title: "[Feature]: "
11+
labels: ["enhancement"]
12+
body: "./ISSUE_TEMPLATE/feature_request.md"
13+
- name: "Documentation"
14+
description: "Suggest updates or additions to the documentation."
15+
title: "[Docs]: "
16+
labels: ["documentation"]
17+
body: "./ISSUE_TEMPLATE/documentation.md"
18+
- name: "General Report"
19+
description: "Provide general feedback or inquiries."
20+
title: "[General]: "
21+
labels: ["general"]
22+
body: "./ISSUE_TEMPLATE/general_report.md"

‎.github/ISSUE_TEMPLATE/custom.md‎

Lines changed: 0 additions & 10 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/documentation.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: Documentation
3+
about: Suggest updates or additions to documentation
4+
title: "[Docs]: "
5+
labels: documentation
6+
assignees: ''
7+
---
8+
9+
### Documentation Update
10+
<!-- What part of the documentation needs to be updated or added? -->
11+
12+
### Why Is This Needed?
13+
<!-- Explain the importance of this update. -->
14+
15+
### Suggested Changes
16+
<!-- Provide a detailed description of the changes. -->
17+
18+
### Additional Context
19+
<!-- Include any related resources. -->

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,28 @@
11
---
22
name: Feature request
3-
about: Suggest an idea for this project
4-
title: ''
5-
labels: ''
3+
about: Suggest an idea
4+
title: '[Feature]: '
5+
labels: 'enhancement'
66
assignees: ''
7-
87
---
98

10-
**Is your feature request related to a problem? Please describe.**
11-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
9+
# Feature Request
10+
11+
## Problem / Motivation
12+
<!-- Describe the problem you want to solve or the motivation for this feature. -->
13+
14+
## Proposed Solution
15+
<!-- Describe the feature you would like to see implemented. Include examples if applicable. -->
1216

13-
**Describe the solution you'd like**
14-
A clear and concise description of what you want to happen.
17+
## Alternatives Considered
18+
- <!-- Alternative 1 -->
19+
- <!-- Alternative 2 -->
1520

16-
**Describe alternatives you've considered**
17-
A clear and concise description of any alternative solutions or features you've considered.
21+
## Expected Impact
22+
<!-- How this feature would affect the codebase or workflow -->
23+
- <!-- Impact 1 -->
24+
- <!-- Impact 2 -->
1825

19-
**Additional context**
20-
Add any other context or screenshots about the feature request here.
26+
## Additional Context
27+
<!-- Add any other context, screenshots, or references for the feature request here. -->
28+
- <!-- Further context -->

‎.github/ISSUE_TEMPLATE/general_report.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
name: General Report
3+
about: Provide general feedback or inquiries
4+
title: "[General]: "
5+
labels: general
6+
assignees: ''
7+
---
8+
9+
### Feedback or Inquiry
10+
<!-- Provide your feedback or inquiry. -->
11+
12+
### Additional Information
13+
<!-- Add any other relevant details here. -->

0 commit comments

Comments
 (0)