Skip to content

Commit bfbc5ee

Browse files
harshendramharshendram
authored
Merge pull request #76 from Kavlin-Kaur/requirements
Added some requirements
2 parents 6138315 + b0fa5ea commit bfbc5ee

File tree

2 files changed

+276
-0
lines changed

2 files changed

+276
-0
lines changed

‎.github/ISSUE_TEMPLATE/document.md‎

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
---
2+
name: 📚 Documentation
3+
about: Improve documentation, tutorials, or educational content
4+
title: '[DOCS] '
5+
labels: 'documentation, good-first-issue'
6+
assignees: ''
7+
8+
---
9+
10+
# 📚 Documentation Issue
11+
12+
## 📋 Documentation Type
13+
- [ ] 📖 README improvements
14+
- [ ] 🎓 Tutorial/Guide creation
15+
- [ ] 📝 Code documentation (JSDoc)
16+
- [ ] 🔧 Setup/Installation guide
17+
- [ ] 🎯 Algorithm explanations
18+
- [ ] 🌐 API documentation
19+
- [ ] 🎨 UI/UX documentation
20+
- [ ] 🧪 Testing documentation
21+
- [ ] 🚀 Deployment guide
22+
- [ ] ❓ FAQ section
23+
24+
## 🔍 Current State
25+
**What documentation is missing or needs improvement?**
26+
Describe the current state of documentation and what specific areas need attention.
27+
28+
**Target Audience:**
29+
- [ ] 👨‍🎓 New contributors
30+
- [ ] 👩‍💻 Developers
31+
- [ ] 👨‍🏫 Educators
32+
- [ ] 👩‍🎓 Students
33+
- [ ] 🌍 End users
34+
35+
## 💡 Proposed Improvements
36+
**What should be documented?**
37+
- [ ] Step-by-step instructions
38+
- [ ] Code examples
39+
- [ ] Screenshots/diagrams
40+
- [ ] Video tutorials
41+
- [ ] Interactive examples
42+
- [ ] Troubleshooting guide
43+
- [ ] Best practices
44+
- [ ] Performance tips
45+
46+
**Content Structure:**
47+
1. [Section 1: Overview/Introduction]
48+
2. [Section 2: Main content]
49+
3. [Section 3: Examples]
50+
4. [Section 4: Advanced topics]
51+
52+
## 🎯 Participation Information
53+
- [ ] I'm participating in Social Summer of Code (SSOC) Season 4
54+
- [ ] I'm willing to work on this documentation
55+
56+
<!--
57+
The following section will only be shown if you're participating in SSOC Season 4.
58+
Please fill this out if you checked the SSOC participation box above.
59+
-->
60+
61+
<details>
62+
<summary>🏆 SSOC Season 4 Details (Click to expand if participating in SSOC)</summary>
63+
64+
### SSOC Information
65+
**Difficulty Level:**
66+
- [ ] 🟢 Beginner (20 points) - Basic documentation, README updates
67+
- [ ] 🟡 Intermediate (30 points) - Comprehensive guides, tutorials
68+
- [ ] 🔴 Advanced (40 points) - Technical documentation, API docs
69+
70+
**Estimated Time:** [e.g., 1-2 days, 3-5 days, 1 week]
71+
72+
**Skills Required:**
73+
- [ ] Technical writing
74+
- [ ] Markdown
75+
- [ ] Algorithm knowledge
76+
- [ ] React/JavaScript (for code docs)
77+
- [ ] Design (for diagrams/screenshots)
78+
- [ ] Video editing (for tutorials)
79+
80+
**Documentation Plan:**
81+
- **Research Phase**: [Gathering information and requirements]
82+
- **Writing Phase**: [Creating content and examples]
83+
- **Review Phase**: [Proofreading and technical accuracy]
84+
- **Polish Phase**: [Final formatting and publication]
85+
86+
**Mentorship:**
87+
- [ ] I can provide guidance for this documentation
88+
- [ ] I need mentorship for this documentation
89+
- [ ] This can be completed independently
90+
91+
</details>
92+
93+
## 📚 Additional Context
94+
**References:**
95+
- Existing documentation: [links]
96+
- Similar projects: [examples]
97+
- Style guides: [if any]
98+
99+
**Success Criteria:**
100+
- [ ] Clear and concise writing
101+
- [ ] Proper formatting and structure
102+
- [ ] Accurate technical information
103+
- [ ] Helpful examples and screenshots
104+
- [ ] Accessible to target audience
105+
106+
## ✅ Checklist
107+
- [ ] I have identified the specific documentation gap
108+
- [ ] I have considered the target audience
109+
- [ ] I have outlined the proposed content structure

‎.github/ISSUE_TEMPLATE/performance.md‎

Lines changed: 167 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,167 @@
1+
---
2+
name: ⚡ Performance Optimization
3+
about: Report performance issues or suggest optimizations
4+
title: '[PERF] '
5+
labels: 'performance, optimization'
6+
assignees: ''
7+
8+
---
9+
10+
# ⚡ Performance Optimization
11+
12+
## 🎯 Performance Issue Type
13+
- [ ] 🐌 Slow rendering/animations
14+
- [ ] 💾 Memory leaks
15+
- [ ] 🔄 Inefficient algorithms
16+
- [ ] 📱 Mobile performance
17+
- [ ] 🌐 Network/loading issues
18+
- [ ] 🎨 UI/Animation lag
19+
- [ ] 📊 Large dataset handling
20+
- [ ] ⚙️ Bundle size optimization
21+
- [ ] 🔧 Code splitting
22+
- [ ] 🚀 Startup performance
23+
24+
## 📊 Current Performance Metrics
25+
**Describe the performance issue:**
26+
What specific performance problem are you experiencing or have identified?
27+
28+
**Measurements (if available):**
29+
- **Load time**: [e.g., 3.2 seconds]
30+
- **Animation FPS**: [e.g., 30 FPS instead of 60 FPS]
31+
- **Memory usage**: [e.g., 150MB after 5 minutes]
32+
- **Bundle size**: [e.g., 2.5MB]
33+
- **Time to interactive**: [e.g., 4.1 seconds]
34+
35+
**Testing Environment:**
36+
- **Device**: [e.g., MacBook Pro M1, iPhone 12, Samsung Galaxy S21]
37+
- **Browser**: [e.g., Chrome 118, Safari 17, Firefox 119]
38+
- **Network**: [e.g., WiFi, 4G, 3G, Slow 3G]
39+
- **Array size tested**: [e.g., 100, 500, 1000 elements]
40+
41+
## 🔍 Root Cause Analysis
42+
**What's causing the performance issue?**
43+
- [ ] Inefficient React re-renders
44+
- [ ] Heavy DOM manipulations
45+
- [ ] Unoptimized algorithms
46+
- [ ] Large bundle size
47+
- [ ] Memory leaks
48+
- [ ] Blocking operations
49+
- [ ] Inefficient CSS/animations
50+
- [ ] Too many event listeners
51+
- [ ] Unoptimized images/assets
52+
- [ ] Synchronous operations
53+
54+
**Profiling Data:**
55+
If you've done performance profiling, please share:
56+
- Browser DevTools Performance tab screenshots
57+
- React DevTools Profiler data
58+
- Lighthouse audit results
59+
- Memory usage graphs
60+
61+
## 💡 Proposed Optimization
62+
**Optimization Strategy:**
63+
- [ ] Code optimization
64+
- [ ] Algorithm improvement
65+
- [ ] Caching implementation
66+
- [ ] Lazy loading
67+
- [ ] Code splitting
68+
- [ ] Bundle optimization
69+
- [ ] Memory management
70+
- [ ] Animation optimization
71+
- [ ] Database/API optimization
72+
- [ ] Asset optimization
73+
74+
**Specific Solutions:**
75+
1. [Solution 1: Detailed description]
76+
2. [Solution 2: Detailed description]
77+
3. [Solution 3: Detailed description]
78+
79+
**Expected Performance Improvement:**
80+
- **Target load time**: [e.g., < 2 seconds]
81+
- **Target FPS**: [e.g., 60 FPS]
82+
- **Memory reduction**: [e.g., 50% less memory usage]
83+
- **Bundle size reduction**: [e.g., 30% smaller]
84+
85+
## 🛠️ Implementation Plan
86+
**Technical Approach:**
87+
- **Tools needed**: [e.g., React.memo, useMemo, Web Workers, etc.]
88+
- **Files to modify**: [list of files/components]
89+
- **Dependencies**: [new libraries or tools]
90+
- **Testing strategy**: [how to measure improvements]
91+
92+
**Potential Risks:**
93+
- [ ] Breaking existing functionality
94+
- [ ] Increased code complexity
95+
- [ ] Compatibility issues
96+
- [ ] Development time impact
97+
98+
## 🎯 Participation Information
99+
- [ ] I'm participating in Social Summer of Code (SSOC) Season 4
100+
- [ ] I'm willing to work on this optimization
101+
102+
<!--
103+
The following section will only be shown if you're participating in SSOC Season 4.
104+
Please fill this out if you checked the SSOC participation box above.
105+
-->
106+
107+
<details>
108+
<summary>🏆 SSOC Season 4 Details (Click to expand if participating in SSOC)</summary>
109+
110+
### SSOC Information
111+
**Difficulty Level:**
112+
- [ ] 🟢 Beginner (20 points) - Simple optimizations, asset compression
113+
- [ ] 🟡 Intermediate (30 points) - React optimizations, algorithm improvements
114+
- [ ] 🔴 Advanced (40 points) - Complex optimizations, architectural changes
115+
116+
**Estimated Time:** [e.g., 3-5 days, 1 week, 2 weeks]
117+
118+
**Skills Required:**
119+
- [ ] JavaScript performance optimization
120+
- [ ] React performance patterns
121+
- [ ] Browser DevTools profiling
122+
- [ ] Algorithm optimization
123+
- [ ] Bundle analysis
124+
- [ ] Memory management
125+
- [ ] CSS/Animation optimization
126+
- [ ] Web performance metrics
127+
128+
**Estimated Impact:**
129+
- [ ] 🌟 High (Significant user experience improvement)
130+
- [ ] 📈 Medium (Noticeable performance gain)
131+
- [ ] 📊 Low (Minor optimization)
132+
133+
**Optimization Plan:**
134+
- **Phase 1**: [Performance analysis and profiling]
135+
- **Phase 2**: [Implementation of optimizations]
136+
- **Phase 3**: [Testing and measurement]
137+
- **Phase 4**: [Documentation and monitoring setup]
138+
139+
**Mentorship:**
140+
- [ ] I can provide guidance for this optimization
141+
- [ ] I need mentorship for this optimization
142+
- [ ] This can be completed independently
143+
144+
</details>
145+
146+
## 📚 Additional Context
147+
**Performance Benchmarks:**
148+
- Current performance: [baseline metrics]
149+
- Target performance: [goal metrics]
150+
- Industry standards: [comparison with similar apps]
151+
152+
**References:**
153+
- Performance audit reports: [links]
154+
- Similar optimizations: [examples from other projects]
155+
- Best practices: [relevant documentation]
156+
157+
**Success Criteria:**
158+
- [ ] Measurable performance improvement
159+
- [ ] No regression in functionality
160+
- [ ] Improved user experience
161+
- [ ] Better performance scores (Lighthouse, etc.)
162+
163+
## ✅ Checklist
164+
- [ ] I have identified the specific performance bottleneck
165+
- [ ] I have provided baseline performance measurements
166+
- [ ] I have proposed a clear optimization strategy
167+
- [ ] I have considered potential risks and mitigation

0 commit comments

Comments
 (0)