Skip to content

Commit bddf508

Browse files
aymanaboghonimaymanaboghonim
committed
Populate issue templates with content and website safety checks
1 parent 489c2a6 commit bddf508

4 files changed

Lines changed: 130 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: '[BUG] '
5+
labels: 'bug'
6+
assignees: ''
7+
---
8+
9+
## Bug Description
10+
A clear and concise description of what the bug is.
11+
12+
## Steps To Reproduce
13+
1. Go to '...'
14+
2. Click on '....'
15+
3. Scroll down to '....'
16+
4. See error
17+
18+
## Expected Behavior
19+
A clear and concise description of what you expected to happen.
20+
21+
## Actual Behavior
22+
A clear and concise description of what actually happened.
23+
24+
## Screenshots
25+
If applicable, add screenshots to help explain your problem.
26+
27+
## Environment
28+
- OS: [e.g. Windows, macOS, Linux]
29+
- Browser: [e.g. Chrome, Safari, Firefox]
30+
- Version: [e.g. 22]
31+
32+
## 🚨 WEBSITE SAFETY CHECK 🚨
33+
Please confirm the following to ensure website functionality is preserved:
34+
35+
- [ ] This bug report DOES NOT suggest changes to the website code in the \src/\ directory
36+
- [ ] This bug report DOES NOT suggest changes to the static assets in \public/\ directory
37+
- [ ] This bug report DOES NOT affect the build configuration
38+
- [ ] This bug report DOES NOT affect deployment scripts
39+
40+
## Additional Context
41+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/documentation.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: Documentation improvement
3+
about: Suggest improvements to our documentation
4+
title: '[DOCS] '
5+
labels: 'documentation'
6+
assignees: ''
7+
---
8+
9+
## Documentation Issue
10+
A clear and concise description of what's wrong or missing in the current documentation.
11+
12+
## Suggested Improvement
13+
A clear and concise description of how you think the documentation should be improved.
14+
15+
## Where This Documentation Should Appear
16+
- [ ] README.md
17+
- [ ] CONTRIBUTING.md
18+
- [ ] CODE_OF_CONDUCT.md
19+
- [ ] docs/ directory
20+
- [ ] Other: (please specify)
21+
22+
## 🚨 WEBSITE SAFETY CHECK 🚨
23+
Please confirm the following to ensure website functionality is preserved:
24+
25+
- [ ] This documentation improvement DOES NOT involve modifying website code in the \src/\ directory
26+
- [ ] This documentation improvement DOES NOT involve modifying static assets in \public/\ directory
27+
- [ ] This documentation improvement DOES NOT affect the build configuration
28+
- [ ] This documentation improvement DOES NOT affect deployment scripts
29+
30+
## Additional Context
31+
Add any other context or screenshots about the documentation improvement here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: '[FEATURE] '
5+
labels: 'enhancement'
6+
assignees: ''
7+
---
8+
9+
## Problem Statement
10+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
11+
12+
## Proposed Solution
13+
A clear and concise description of what you want to happen.
14+
15+
## Alternatives Considered
16+
A clear and concise description of any alternative solutions or features you've considered.
17+
18+
## 🚨 WEBSITE SAFETY CHECK 🚨
19+
Please confirm the following to ensure website functionality is preserved:
20+
21+
- [ ] This feature request DOES NOT involve modifying website code in the \src/\ directory
22+
- [ ] This feature request DOES NOT involve modifying static assets in \public/\ directory
23+
- [ ] This feature request DOES NOT affect the build configuration
24+
- [ ] This feature request DOES NOT affect deployment scripts
25+
26+
*If your feature does require website changes, please discuss with maintainers first.*
27+
28+
## Additional Context
29+
Add any other context or screenshots about the feature request here.

‎.github/ISSUE_TEMPLATE/question.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: Question
3+
about: Ask a question about this project
4+
title: '[QUESTION] '
5+
labels: 'question'
6+
assignees: ''
7+
---
8+
9+
## Question
10+
A clear and concise description of your question.
11+
12+
## Context
13+
Add any context that might help us answer your question.
14+
15+
## What I've Tried Already
16+
Explain what you've already tried or what research you've already done.
17+
18+
## 🚨 WEBSITE SAFETY CHECK 🚨
19+
Please confirm the following to ensure website functionality is preserved:
20+
21+
- [ ] My question is NOT about modifying website code in the \src/\ directory
22+
- [ ] My question is NOT about modifying static assets in \public/\ directory
23+
- [ ] My question is NOT about modifying the build configuration
24+
- [ ] My question is NOT about modifying deployment scripts
25+
26+
*If your question does involve website changes, please add a special note at the beginning of your question.*
27+
28+
## Additional Information
29+
Any additional information that might be helpful.

0 commit comments

Comments
 (0)