Skip to content

Commit d3a8192

Browse files
committed
updated issue templates; added PR template
1 parent 5e3fa44 commit d3a8192

File tree

4 files changed

+37
-25
lines changed

4 files changed

+37
-25
lines changed
Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,29 @@
11
---
22
name: Bug report
3-
about: Create a report to help us improve
3+
about: Report a problem to help us improve
44
title: "[bug]"
55
labels: bug
66
assignees: markleader
7-
87
---
98

10-
**Describe the bug**
11-
A clear and concise description of what the bug is.
12-
13-
- Interface(s) affected: [e.g. Fortran, C, legacy, Python]
14-
15-
- Is this an issue with backwards-compatibility using the legacy interface? If so, paste the the `.inp` problem file, and the relevant output for inspection.
9+
**Summary**
10+
A clear, concise description of the bug.
1611

17-
**To Reproduce**
18-
Steps to reproduce the behavior:
12+
**Reproduction**
13+
- Interface: [Fortran | C | Python | legacy]
14+
- Minimal input / steps (attach .inp if relevant):
15+
- Command or API call used:
1916

2017
**Expected behavior**
21-
A clear and concise description of what you expected to happen.
18+
What you expected to happen.
2219

23-
**Screenshots**
24-
If applicable, add screenshots to help explain your problem.
20+
**Actual behavior**
21+
What happened (include key error messages/output).
2522

26-
**Build architecture (please complete the following information):**
27-
- OS: [e.g. Mac OS, Windows]
28-
- Fortran compiler [e.g. gfortran, ifort]
29-
- Version [e.g. 3.0.0]
23+
**Environment**
24+
- OS:
25+
- CEA version/commit:
26+
- Compiler or Python version (if relevant):
3027

3128
**Additional context**
32-
Add any other context about the problem here.
29+
Anything else helpful (optional).
Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
11
---
22
name: Feature request
3-
about: Suggest an idea for this project
3+
about: Suggest an improvement
44
title: "[feature]"
55
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. It is difficult to [...]
9+
**Problem / use case**
10+
What’s hard or missing today?
1211

13-
**Describe the solution you'd like**
14-
A clear and concise description of what you want to happen.
12+
**Proposed solution**
13+
What would you like to see?
1514

1615
**Additional context**
17-
Add any other context or screenshots about the feature request here.
16+
Examples, references, or alternatives (optional).

.github/pull_request_template.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
## Summary
2+
3+
## Changes
4+
5+
## Testing
6+
- Not run (explain why)
7+
8+
## Compatibility / Numerical behavior
9+
- [ ] No expected changes to numerical results
10+
- [ ] Expected changes (explain and provide validation)

CONTRIBUTING.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,9 @@ Large refactors or algorithmic changes should be discussed before implementation
8282
- Why the change is needed
8383
- Whether numerical behavior is expected to change
8484
This helps avoid duplicated effort and ensures alignment.
85+
Use the issue templates for bug reports and feature requests:
86+
- `.github/ISSUE_TEMPLATE/bug_report.md`
87+
- `.github/ISSUE_TEMPLATE/feature_request.md`
8588

8689
2. **Make Small, Focused Changes**
8790
Each pull request should ideally address one concern:
@@ -250,6 +253,9 @@ Your PR description should include:
250253
- Impacted components
251254
- Whether numerical behavior changes (yes/no)
252255

256+
The PR template provides a concise checklist:
257+
- `.github/pull_request_template.md`
258+
253259
## What Not to Change
254260

255261
Please do not:

0 commit comments

Comments
 (0)