Skip to content

Commit 8e0b3d1

Browse files
authored
Merge pull request #51 from sourcefuse/templates
update issue template
2 parents 0015609 + 0ccf293 commit 8e0b3d1

File tree

3 files changed

+97
-0
lines changed

3 files changed

+97
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

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: Create a report to help us improve
4+
title: ''
5+
labels: 'bug'
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
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. iOS]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
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]
36+
37+
**Additional context**
38+
Add any other context about the problem here.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: 'enhancement'
6+
assignees: ''
7+
8+
---
9+
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 [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
## Description
2+
3+
Please provide a brief description of the changes introduced by this pull request.
4+
5+
## Related Issue
6+
7+
- [Issue Number](link-to-issue): Brief description
8+
9+
## Checklist
10+
11+
Please ensure that the following steps are completed before submitting the pull request:
12+
13+
- [ ] Code follows the Terraform best practices and style guidelines.
14+
- [ ] Changes are appropriately documented, including any necessary updates to README or other documentation files.
15+
- [ ] Unit tests have been added or updated to cover the changes introduced by this pull request.
16+
- [ ] Changes have been tested locally and verified to work as expected.
17+
- [ ] The code has been reviewed to ensure it aligns with the project's goals and standards.
18+
- [ ] Dependencies and backward compatibility have been considered and addressed if applicable.
19+
20+
## Type of change
21+
22+
Please delete options that are not relevant.
23+
24+
- [ ] Bug fix (non-breaking change which fixes an issue)
25+
- [ ] New feature (non-breaking change which adds functionality)
26+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
27+
- [ ] Intermediate change (work in progress)
28+
29+
## Testing Instructions
30+
31+
Provide detailed steps or instructions for testing the changes introduced by this pull request.
32+
33+
## Screenshots
34+
35+
Include any relevant screenshots or visual aids to help reviewers understand the changes visually, if applicable.
36+
37+
## Additional Notes
38+
39+
Add any additional notes or context that might be helpful for reviewers or users testing the changes.

0 commit comments

Comments
 (0)