Skip to content

Commit a10539e

Browse files
KunjShah95apsinghdev
authored andcommitted
feat: add issue and pull request templates for better contribution guidelines
1 parent 20cdd97 commit a10539e

File tree

4 files changed

+151
-0
lines changed

4 files changed

+151
-0
lines changed
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
name: Bug Report
3+
description: Report a bug or issue
4+
title: "[BUG] "
5+
labels: ["bug"]
6+
assignees: []
7+
body:
8+
- type: textarea
9+
id: description
10+
attributes:
11+
label: Description
12+
description: A clear and concise description of the bug.
13+
placeholder: Describe what happened...
14+
validations:
15+
required: true
16+
- type: textarea
17+
id: steps
18+
attributes:
19+
label: Steps to Reproduce
20+
description: Steps to reproduce the behavior.
21+
placeholder: |
22+
1. Go to '...'
23+
2. Click on '...'
24+
3. Scroll down to '...'
25+
4. See error
26+
validations:
27+
required: true
28+
- type: textarea
29+
id: expected
30+
attributes:
31+
label: Expected Behavior
32+
description: What you expected to happen.
33+
validations:
34+
required: true
35+
- type: textarea
36+
id: actual
37+
attributes:
38+
label: Actual Behavior
39+
description: What actually happened.
40+
validations:
41+
required: true
42+
- type: input
43+
id: version
44+
attributes:
45+
label: Version
46+
description: What version of the software are you using?
47+
placeholder: e.g., v1.0.0
48+
- type: input
49+
id: environment
50+
attributes:
51+
label: Environment
52+
description: What environment are you running in?
53+
placeholder: e.g., Browser, Node.js version, OS
54+
- type: textarea
55+
id: additional
56+
attributes:
57+
label: Additional Context
58+
description: Add any other context about the problem here.
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
name: Feature Request
3+
description: Suggest a new feature or enhancement
4+
title: "[FEATURE] "
5+
labels: ["enhancement"]
6+
assignees: []
7+
body:
8+
- type: textarea
9+
id: summary
10+
attributes:
11+
label: Summary
12+
description: A brief summary of the feature request.
13+
placeholder: What feature would you like to see?
14+
validations:
15+
required: true
16+
- type: textarea
17+
id: problem
18+
attributes:
19+
label: Problem
20+
description: What problem does this feature solve?
21+
placeholder: Is there a problem this feature would solve? If so, describe it.
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: solution
26+
attributes:
27+
label: Proposed Solution
28+
description: Describe the solution you'd like.
29+
placeholder: How would you like this feature to work?
30+
validations:
31+
required: true
32+
- type: textarea
33+
id: alternatives
34+
attributes:
35+
label: Alternatives Considered
36+
description: Have you considered any alternative solutions?
37+
placeholder: Describe any alternative solutions or features you've considered.
38+
- type: textarea
39+
id: additional
40+
attributes:
41+
label: Additional Context
42+
description: Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/general.yml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: General Issue
3+
description: For general questions, discussions, or other issues
4+
title: "[GENERAL] "
5+
labels: []
6+
assignees: []
7+
body:
8+
- type: textarea
9+
id: description
10+
attributes:
11+
label: Description
12+
description: Describe your issue or question.
13+
placeholder: What is your question or issue?
14+
validations:
15+
required: true
16+
- type: textarea
17+
id: context
18+
attributes:
19+
label: Context
20+
description: Provide any additional context or details.
21+
- type: textarea
22+
id: additional
23+
attributes:
24+
label: Additional Information
25+
description: Any other information that might be helpful.
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
## Description
2+
Please include a summary of the changes and the related issue. Please also include relevant motivation and context.
3+
4+
## Type of Change
5+
- [ ] Bug fix (non-breaking change which fixes an issue)
6+
- [ ] New feature (non-breaking change which adds functionality)
7+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
8+
- [ ] Documentation update
9+
- [ ] Refactor
10+
- [ ] Other (please specify):
11+
12+
## Checklist
13+
- [ ] My code follows the project's style guidelines
14+
- [ ] I have performed a self-review of my own code
15+
- [ ] I have commented my code, particularly in hard-to-understand areas
16+
- [ ] I have made corresponding changes to the documentation
17+
- [ ] My changes generate no new warnings
18+
- [ ] I have added tests that prove my fix is effective or that my feature works
19+
- [ ] New and existing unit tests pass locally with my changes
20+
- [ ] Any dependent changes have been merged and published in downstream modules
21+
22+
## Related Issues
23+
Closes #
24+
25+
## Screenshots (if applicable)
26+
<!-- Add screenshots to help explain your changes -->

0 commit comments

Comments
 (0)