Skip to content

Commit 5bff8be

Browse files
steam-bell-92steam-bell-92
authored
Introduced ISSUE_TEMPLATE & pull_request.md (#1452)
1 parent ca0c44f commit 5bff8be

File tree

4 files changed

+179
-0
lines changed

4 files changed

+179
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug.yml‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: Bug report 🐞
2+
description: File a bug report
3+
title: "🐞[Bug]: "
4+
labels: 'bug'
5+
body:
6+
- type: checkboxes
7+
id: existing-issue
8+
attributes:
9+
label: Is there an existing issue for this?
10+
description: Please search to see if an issue already exists for the bug you encountered.
11+
options:
12+
- label: I have searched the existing issues
13+
required: true
14+
- type: textarea
15+
id: what-happened
16+
attributes:
17+
label: Describe the bug
18+
description: A concise description of what you are experiencing.
19+
placeholder: Tell us what you see!
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: expected-behaviour
24+
attributes:
25+
label: Expected behavior
26+
description: A clear and concise description of what you expected to happen.
27+
validations:
28+
required: true
29+
- type: textarea
30+
id: screenshots
31+
attributes:
32+
label: Add ScreenShots
33+
description: Add sufficient ScreenShots to explain your issue.
34+
- type: dropdown
35+
id: browsers
36+
attributes:
37+
label: What browsers are you seeing the problem on?
38+
multiple: true
39+
options:
40+
- Firefox
41+
- Chrome
42+
- Safari
43+
- Microsoft Edge
44+
- type: checkboxes
45+
id: terms
46+
attributes:
47+
label: Record
48+
options:
49+
- label: "I have read the Contributing Guidelines"
50+
required: true
51+
- label: "I want to work on this issue"
52+
required: false

‎.github/ISSUE_TEMPLATE/documentation.yml‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: 📝 Documentation Update
2+
description: Improve Documentation
3+
title: "📝[Docs]: "
4+
labels: 'enhancement'
5+
body:
6+
- type: checkboxes
7+
id: existing-issue
8+
attributes:
9+
label: Is there an existing issue for this?
10+
description: Please search to see if an issue already exists for the updates you want to make.
11+
options:
12+
- label: I have searched the existing issues
13+
required: true
14+
- type: textarea
15+
id: issue-description
16+
attributes:
17+
label: Issue Description
18+
description: Please provide a clear description of the documentation update you are suggesting.
19+
placeholder: Describe the improvement or correction you'd like to see in the documentation.
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: suggested-change
24+
attributes:
25+
label: Suggested Change
26+
description: Provide details of the proposed change to the documentation.
27+
placeholder: Explain how the documentation should be updated or corrected.
28+
validations:
29+
required: true
30+
- type: textarea
31+
id: rationale
32+
attributes:
33+
label: Rationale
34+
description: Why is this documentation update necessary or beneficial?
35+
placeholder: Explain the importance or reasoning behind the suggested change.
36+
- type: checkboxes
37+
id: terms
38+
attributes:
39+
label: Record
40+
options:
41+
- label: "I have read the Contributing Guidelines"
42+
required: true
43+
- label: "I want to work on this issue"
44+
required: false

‎.github/ISSUE_TEMPLATE/feature.yml‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: 💡Feature Request
2+
description: Suggest a feature
3+
title: "💡[Feature]: "
4+
labels: "enhancement"
5+
body:
6+
- type: checkboxes
7+
id: existing-issue
8+
attributes:
9+
label: Is there an existing issue for this?
10+
description: Please search to see if an issue already exists for this feature.
11+
options:
12+
- label: I have searched the existing issues
13+
required: true
14+
- type: textarea
15+
id: feature-description
16+
attributes:
17+
label: Feature Description
18+
description: Please provide a detailed description of the feature you are requesting.
19+
placeholder: Describe the new feature or enhancement you'd like to see.
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: use-case
24+
attributes:
25+
label: Use Case
26+
description: How would this feature enhance your use of the project?
27+
placeholder: Describe a specific use case or scenario where this feature would be beneficial.
28+
validations:
29+
required: true
30+
- type: textarea
31+
id: benefits
32+
attributes:
33+
label: Benefits
34+
description: What benefits would this feature bring to the project or community?
35+
placeholder: Explain the advantages of implementing this feature.
36+
- type: textarea
37+
id: screenShots
38+
attributes:
39+
label: Add ScreenShots
40+
description: If any...
41+
- type: checkboxes
42+
id: terms
43+
attributes:
44+
label: Record
45+
options:
46+
- label: "I have read the Contributing Guidelines"
47+
required: true
48+
- label: "I want to work on this issue"
49+
required: false

‎.github/pull_request.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
## Description
2+
3+
<!--
4+
Provide a brief summary of the changes made to the website and the motivation behind them. Include any relevant issues or tickets.
5+
This helps fast tracking your PR and merge it, Check the respective box below.
6+
-->
7+
Fixes # (issue)
8+
9+
## Type of Change
10+
11+
- [ ] New feature (e.g., new page, component, or functionality)
12+
- [ ] Bug fix (non-breaking change that fixes an issue)
13+
- [ ] UI/UX improvement (design, layout, or styling updates)
14+
- [ ] Performance optimization (e.g., code splitting, caching)
15+
- [ ] Documentation update (README, contribution guidelines, etc.)
16+
- [ ] Other (please specify):
17+
18+
## Changes Made
19+
20+
<!--
21+
Describe the key changes (e.g., new sections, updated components, responsive fixes).
22+
-->
23+
24+
## Dependencies
25+
26+
- List any new dependencies or tools required for this change.
27+
- Mention any version updates or configurations that need to be considered.
28+
29+
## Checklist
30+
31+
- [ ] My code follows the style guidelines of this project.
32+
- [ ] I have tested my changes across major browsers and devices
33+
- [ ] My changes do not generate new console warnings or errors .
34+
- [ ] This is already assigned Issue to me, not an unassigned issue.

0 commit comments

Comments
 (0)