Skip to content

Commit d4888a3

Browse files
authored
chore: Adding pull request and issues templates (#170)
This PR adds a few issues templates as well as a pull request template.
1 parent 0cec840 commit d4888a3

File tree

3 files changed

+94
-0
lines changed

3 files changed

+94
-0
lines changed
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug or issue
4+
title: "[BUG]"
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## Bug Report
10+
11+
### Description
12+
A clear and concise description of what the bug is.
13+
14+
### Steps to Reproduce
15+
1. Step one
16+
2. Step two
17+
3. Step three
18+
4. See the error
19+
20+
### Expected Behavior
21+
A clear description of what you expected to happen.
22+
23+
### Actual Behavior
24+
A clear description of what actually happened.
25+
26+
### Screenshots
27+
If applicable, add screenshots to help explain your problem.
28+
29+
### Environment
30+
- **Operating System**: (e.g., Ubuntu, RedHat, Windows)
31+
- **Version**: (e.g., 1.0.0)
32+
- **Any Model Components Impacted**: (e.g., `base_objects`)
33+
34+
### Additional Context
35+
Add any other context about the problem here, such as logs or error messages.
36+
37+
### Checklist
38+
- [ ] I have included no proprietary/sensitive information in my issue.
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a new idea or feature for this project
4+
title: "[FEATURE]"
5+
labels: feature
6+
assignees: ''
7+
---
8+
9+
## Feature Request
10+
11+
### Summary
12+
A brief description of the feature you would like to see implemented.
13+
14+
### Motivation
15+
Why is this feature important? How will it benefit the users or the project?
16+
17+
### Proposed Solution
18+
Describe how you envision the feature being implemented. Include any relevant details, such as:
19+
- API changes
20+
- User experience changes
21+
- Any other relevant information
22+
23+
### Alternatives Considered
24+
Have you considered any alternative solutions or approaches? If so, please describe them.
25+
26+
### Additional Context
27+
Add any other context or screenshots about the feature request here.
28+
29+
### Checklist
30+
- [ ] I have included no proprietary/sensitive information in my issue.

.github/pull_request_template.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Pull Request Title
2+
3+
## Description
4+
Please include a summary of the changes and the related issue.
5+
6+
## Related Issue
7+
If applicable, please link to the issue here (e.g., #123).
8+
9+
## Type of Change
10+
Please select the type of change your pull request introduces:
11+
- [ ] Bugfix
12+
- [ ] New feature
13+
- [ ] Documentation update
14+
- [ ] Other (please describe):
15+
16+
## Checklist
17+
- [ ] This PR conforms to the process detailed in the [Contributing Guide](https://sandialabs.github.io/firewheel/developer/contributing.html).
18+
- [ ] I have included no proprietary/sensitive information in my code.
19+
- [ ] I have performed a self-review of my code.
20+
- [ ] I have commented my code, particularly in hard-to-understand areas.
21+
- [ ] I have made corresponding changes to the documentation.
22+
- [ ] My changes generate no new warnings.
23+
- [ ] I have tested my code.
24+
25+
## Additional Notes
26+
Please provide any additional information or context for your pull request here.

0 commit comments

Comments
 (0)