Skip to content

Commit a380ba9

Browse files
vigneshs-embdvigneshs-embd
committed
Add README.md file and CONTRIBTUING.md file
1 parent 64cdadd commit a380ba9

File tree

7 files changed

+628
-1
lines changed

7 files changed

+628
-1
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
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+
## 📸 Screenshots
22+
<!-- If applicable, add screenshots to help explain your problem -->
23+
24+
## 🖥️ Environment
25+
- OS: [e.g., Windows 10, macOS 12.0]
26+
- Browser: [e.g., Chrome 96, Safari 15]
27+
- Frontend Version: [e.g., React 18.2.0]
28+
- Backend Version: [e.g., Go 1.19]
29+
- Node Version: [e.g., 16.13.0]
30+
31+
## 📱 Additional Context
32+
<!-- Add any other context about the problem here -->
33+
34+
## 🔍 Possible Solution
35+
<!-- Optional: If you have suggestions on a fix for the bug -->

‎.github/ISSUE_TEMPLATE/documentation.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: 📚 Documentation
3+
about: Report missing or incorrect documentation
4+
title: '[DOCS] '
5+
labels: 'documentation'
6+
assignees: ''
7+
---
8+
9+
## 📝 Documentation Description
10+
<!-- Describe what documentation is missing or needs to be updated -->
11+
12+
## 📍 Location
13+
<!-- Where should this documentation be added/updated? -->
14+
15+
## 🔍 Additional Information
16+
<!-- What information should be included in the documentation? -->
17+
18+
## 📋 Checklist
19+
- [ ] README updates
20+
- [ ] Code comments
21+
- [ ] API documentation
22+
- [ ] Setup instructions
23+
- [ ] Contributing guidelines

‎.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: ✨ Feature Request
3+
about: Suggest an idea for this project
4+
title: '[FEATURE] '
5+
labels: 'enhancement'
6+
assignees: ''
7+
---
8+
9+
## 🎯 Feature Description
10+
<!-- A clear and concise description of what feature you would like -->
11+
12+
## 📝 Problem Statement
13+
<!-- A clear and concise description of what problem this feature would solve -->
14+
15+
## 🔄 Proposed Solution
16+
<!-- A clear and concise description of what you want to happen -->
17+
18+
## 🤔 Alternatives Considered
19+
<!-- A clear and concise description of any alternative solutions or features you've considered -->
20+
21+
## 📸 Mockups / Screenshots
22+
<!-- If applicable, add mockups or screenshots to help explain your feature -->
23+
24+
## 📱 Additional Context
25+
<!-- Add any other context about the feature request here -->
26+
27+
## 📋 Implementation Checklist
28+
<!-- Optional: List the steps needed to implement this feature -->
29+
- [ ] Frontend changes required
30+
- [ ] Backend API changes required
31+
- [ ] Database changes required
32+
- [ ] Documentation updates needed

‎.github/pull_request_template.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
## 📝 Description
2+
<!-- Describe your changes in detail -->
3+
4+
## 🔗 Related Issue
5+
<!-- Link to the issue this PR resolves -->
6+
Closes #[issue_number]
7+
8+
## 🧪 Type of Change
9+
<!-- Mark with an 'x' all that apply -->
10+
- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
11+
- [ ] ✨ New feature (non-breaking change which adds functionality)
12+
- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
13+
- [ ] 📚 Documentation update
14+
- [ ] 🔄 Code refactor
15+
- [ ] 🎨 Style update
16+
- [ ] 📊 Performance improvement
17+
18+
## 🧪 Testing
19+
<!-- Describe the tests you ran to verify your changes -->
20+
- [ ] Test A
21+
- [ ] Test B
22+
23+
## 📸 Screenshots
24+
<!-- If applicable, add screenshots to help explain your changes -->
25+
26+
## 📋 Checklist
27+
<!-- Mark with an 'x' all that apply -->
28+
- [ ] My code follows the style guidelines of this project
29+
- [ ] I have performed a self-review of my code
30+
- [ ] I have commented my code, particularly in hard-to-understand areas
31+
- [ ] I have made corresponding changes to the documentation
32+
- [ ] My changes generate no new warnings
33+
- [ ] I have added tests that prove my fix is effective or that my feature works
34+
- [ ] New and existing unit tests pass locally with my changes
35+
- [ ] Any dependent changes have been merged and published
36+
- [ ] I have updated the README if necessary
37+
38+
## 🌱 Dependencies
39+
<!-- List any dependencies that are required for this change -->
40+
41+
## 📱 Additional Context
42+
<!-- Add any other context about the PR here -->
43+
44+
## 👥 Reviewers
45+
<!-- @mention people who should review this PR -->

0 commit comments

Comments
 (0)