Skip to content

Commit f5f123a

Browse files
Pritam-ReddyPritam-Reddy
authored
Created ISSUE TEMPLATE folder with BUG-REPORT, DOC-UPDATE, FEATURE REQUEST - GENERAL ISSUE.yaml files (#15)
Templates created successfully
1 parent 2be5b90 commit f5f123a

File tree

4 files changed

+202
-0
lines changed

4 files changed

+202
-0
lines changed

Diff for: ‎.github/ISSUE_TEMPLATE/Bug-report.yaml

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: ​🐞 Bug
2+
description: Report an issue to help us improve the project.
3+
title: "[BUG] <write a small description here>"
4+
labels: ["bug", "goal: fix", "priority: medium"]
5+
body:
6+
- type: textarea
7+
attributes:
8+
label: Description
9+
description: A brief description of the issue or bug you are facing, also include what you tried and what didn't work.
10+
validations:
11+
required: false
12+
- type: textarea
13+
attributes:
14+
label: Screenshots
15+
description: Please add screenshots if applicable
16+
validations:
17+
required: false
18+
- type: textarea
19+
attributes:
20+
label: Any additional information?
21+
description: Any additional information or Is there anything we should know about this bug?
22+
validations:
23+
required: false
24+
- type: dropdown
25+
attributes:
26+
label: What browser are you seeing the problem on?
27+
multiple: true
28+
options:
29+
- Firefox
30+
- Chrome
31+
- Safari
32+
- Microsoft Edge

Diff for: ‎.github/ISSUE_TEMPLATE/Feature-Request.yaml

+71
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
name: "✨ Feature Request"
2+
description: "Suggest a new feature to enhance our Leetcode-Journal"
3+
title: "[FEATURE] "
4+
labels: ["enhancement"]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
# Feature Request
11+
Thanks for taking the time to suggest a new feature!
12+
Please fill out the information below to help us understand your suggestion better.
13+
14+
- type: textarea
15+
id: problem
16+
attributes:
17+
label: "Problem Statement"
18+
description: "What problem does this feature solve?"
19+
placeholder: "I'm always frustrated when..."
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: solution
25+
attributes:
26+
label: "Proposed Solution"
27+
description: "Describe the solution you'd like"
28+
placeholder: "It would be great if..."
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: alternatives
34+
attributes:
35+
label: "Alternative Solutions"
36+
description: "What alternatives have you considered?"
37+
placeholder: "Another approach could be..."
38+
39+
- type: textarea
40+
id: screenshots
41+
attributes:
42+
label: "Screenshots or Mockups"
43+
description: "Add any relevant screenshots, mockups or examples"
44+
placeholder: "Drag and drop images here..."
45+
46+
- type: dropdown
47+
id: priority
48+
attributes:
49+
label: "Priority"
50+
options:
51+
- High
52+
- Medium
53+
- Low
54+
validations:
55+
required: true
56+
57+
- type: checkboxes
58+
id: terms
59+
attributes:
60+
label: "Contribution Guidelines"
61+
options:
62+
- label: "I have searched [existing issues](https://github.com/yashksaini-coder/Leetcode-Journal/issues) and this is not a duplicate"
63+
required: true
64+
- label: "I would like to implement this feature"
65+
required: false
66+
67+
- type: markdown
68+
attributes:
69+
value: |
70+
---
71+
💡 Thank you for contributing to make our Leetcode Journal better!

Diff for: ‎.github/ISSUE_TEMPLATE/General_issue.yaml

+67
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
name: "🤔 General Issue"
2+
description: "Submit a general question, suggestion or issue"
3+
title: "[GENERAL] "
4+
labels: ["triage-needed"]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
# General Issue Template
11+
Thanks for taking the time to fill out this issue! Please provide as much information as possible.
12+
13+
- type: dropdown
14+
id: category
15+
attributes:
16+
label: "Category"
17+
description: "What type of issue is this?"
18+
options:
19+
- Question
20+
- Suggestion
21+
- Problem
22+
- Other
23+
validations:
24+
required: true
25+
26+
- type: textarea
27+
id: description
28+
attributes:
29+
label: "Description"
30+
description: "What would you like to share or ask?"
31+
placeholder: "Provide details about your issue, question, or suggestion..."
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
id: additional
37+
attributes:
38+
label: "Additional Context"
39+
description: "Add any other context, screenshots, or relevant information"
40+
placeholder: "Add any additional details here..."
41+
42+
- type: dropdown
43+
id: impact
44+
attributes:
45+
label: "Impact Level"
46+
options:
47+
- High
48+
- Medium
49+
- Low
50+
validations:
51+
required: true
52+
53+
- type: checkboxes
54+
id: terms
55+
attributes:
56+
label: "Contribution Guidelines"
57+
options:
58+
- label: "I have searched [existing issues](https://github.com/yashksaini-coder/Leetcode-Journal/issues) to avoid duplicates"
59+
required: true
60+
- label: "I would like to help resolve this issue"
61+
required: false
62+
63+
- type: markdown
64+
attributes:
65+
value: |
66+
---
67+
Thank you for contributing to our project! 🙏

Diff for: ‎.github/Pull_request_Template.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Pull Request Template
2+
3+
## Summary
4+
Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.
5+
6+
Fixes # (issue)
7+
8+
## Type of Change
9+
Please mark [X] for applicable items:
10+
11+
- [ ] Bug fix (non-breaking change which fixes an issue)
12+
- [ ] New feature (non-breaking change which adds functionality)
13+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
14+
- [ ] Documentation update
15+
- [ ] Code refactoring
16+
- [ ] Other (please describe):
17+
18+
## Testing
19+
Please describe the tests you performed to verify your changes:
20+
21+
## Screenshots/Videos
22+
Please attach relevant screenshots or videos demonstrating the changes.
23+
24+
## Checklist
25+
Please mark [X] for completed items:
26+
27+
- [ ] My code follows the project's style guidelines
28+
- [ ] I have performed a self-review of my code
29+
- [ ] I have commented my code, particularly in hard-to-understand areas
30+
- [ ] I have updated the documentation accordingly
31+
- [ ] My changes generate no new warnings
32+
- [ ] I have added tests that prove my fix is effective or that my feature works

0 commit comments

Comments
 (0)