Skip to content

Commit 61c9d3c

Browse files
committed
add issue/bug and PR templates
1 parent a970f68 commit 61c9d3c

File tree

2 files changed

+85
-0
lines changed

2 files changed

+85
-0
lines changed
+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
name: 🐞 Bug
3+
about: File a bug/issue
4+
title: '[BUG] <title>'
5+
labels: Bug, Needs Triage
6+
assignees: ''
7+
8+
---
9+
10+
## Bug Report
11+
12+
**Describe the Bug:**
13+
<!-- A clear and concise description of the bug -->
14+
15+
**To Reproduce:**
16+
<!-- Steps to reproduce the behavior -->
17+
18+
1. Step 1
19+
2. Step 2
20+
3. ...
21+
22+
**Expected Behavior:**
23+
<!-- A clear and concise description of what you expected to happen -->
24+
25+
**Actual Behavior:**
26+
<!-- A clear and concise description of what actually happened -->
27+
28+
**Screenshots (if applicable):**
29+
<!-- If applicable, add screenshots to help explain your problem -->
30+
31+
**Environment:**
32+
- Noticed gem version: <!-- Specify the version of the Noticed gem where the bug occurred -->
33+
- Ruby version: <!-- Specify the version of Ruby you are using -->
34+
- Rails version: <!-- Specify the version of Rails you are using -->
35+
- Operating System: <!-- Specify your operating system -->
36+
37+
**Additional Context:**
38+
<!-- Add any other context about the problem here -->
39+
40+
**Possible Fix:**
41+
<!-- If you have suggestions on how to fix the bug, you can provide them here -->
42+
43+
**Steps to Reproduce with Fix (if available):**
44+
<!-- If you have a fix, outline the steps to reproduce the bug using your fix -->
45+
46+
**Related Issues:**
47+
<!-- If applicable, reference any related GitHub issues or pull requests -->
48+
49+
**Labels to Apply:**
50+
<!-- Suggest labels that should be applied to this issue -->
51+
52+
**Checklist:**
53+
<!-- Make sure all of these items are completed before submitting the issue -->
54+
55+
- [ ] I have searched for similar issues and couldn't find any
56+
- [ ] I have checked the documentation for relevant information
57+
- [ ] I have included all the required information

.github/pull_request_template.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
## Pull Request
2+
3+
**Summary:**
4+
<!-- Provide a brief summary of the changes in this pull request -->
5+
6+
**Related Issue:**
7+
<!-- If applicable, reference the GitHub issue that this pull request resolves -->
8+
9+
**Description:**
10+
<!-- Elaborate on the changes made in this pull request. What motivated these changes? -->
11+
12+
**Testing:**
13+
<!-- Describe the steps you've taken to test the changes. Include relevant information for other contributors to verify the modifications -->
14+
15+
**Screenshots (if applicable):**
16+
<!-- Include any relevant screenshots or GIFs that demonstrate the changes -->
17+
18+
**Checklist:**
19+
<!-- Make sure all of these items are completed before submitting the pull request -->
20+
21+
- [ ] Code follows the project's coding standards
22+
- [ ] Tests have been added or updated to cover the changes
23+
- [ ] Documentation has been updated (if applicable)
24+
- [ ] All existing tests pass
25+
- [ ] Conforms to the contributing guidelines
26+
27+
**Additional Notes:**
28+
<!-- Any additional information or notes for the reviewers -->

0 commit comments

Comments
 (0)