Skip to content

Commit 4ab1f3f

Browse files
Merge pull request #133 from Vanshikakhasat/main
Add Documentation for Issue Difficulty Levels
2 parents 70bd490 + b5965cb commit 4ab1f3f

1 file changed

Lines changed: 110 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ git push origin feature/your-project-name
7070
# Go to GitHub and create a Pull Request
7171
```
7272

73+
7374
---
7475

7576
## 📋 Project Guidelines
@@ -329,6 +330,115 @@ New to contributing? Check these out:
329330
- [Emoji Cheat Sheet](https://github.com/ikatyang/emoji-cheat-sheet)
330331

331332
---
333+
## Issue Difficulty Levels
334+
335+
To make contributing easier for everyone, we use difficulty labels for issues.
336+
These labels help contributors understand how much experience or effort an issue may require before getting started.
337+
338+
---
339+
340+
### level: Beginner
341+
342+
Good for first-time contributors or people who are still learning the project structure.
343+
344+
#### What to Expect
345+
- Small and simple changes
346+
- Easy to understand
347+
- Usually does not require deep project knowledge
348+
349+
#### Criteria
350+
- Minor bug fixes
351+
- Simple documentation updates
352+
- Small UI/text changes
353+
- Basic code cleanup
354+
355+
#### Example Issues
356+
- Fix spelling mistakes in documentation
357+
- Improve README formatting
358+
- Rename variables for better readability
359+
- Add comments to simple functions
360+
- Update broken links
361+
362+
---
363+
364+
### level: Intermediate
365+
366+
Best for contributors who are comfortable reading and understanding the codebase.
367+
368+
#### What to Expect
369+
- Moderate coding tasks
370+
- Requires understanding of project flow
371+
- May involve working across multiple files
372+
373+
#### Criteria
374+
- Feature improvements
375+
- Refactoring existing code
376+
- Writing tests
377+
- Fixing medium-level bugs
378+
379+
#### Example Issues
380+
- Add validation to forms or APIs
381+
- Improve performance of an existing feature
382+
- Write unit tests for modules
383+
- Refactor repeated code into reusable functions
384+
- Improve error handling
385+
386+
---
387+
388+
### level: Advanced
389+
390+
Recommended for experienced contributors who understand the architecture of the project.
391+
392+
#### What to Expect
393+
- Complex tasks
394+
- Requires strong debugging and problem-solving skills
395+
- May involve major feature development or architectural changes
396+
397+
#### Criteria
398+
- Large feature implementations
399+
- System design changes
400+
- Complex bug fixes
401+
- Multi-module updates
402+
403+
#### Example Issues
404+
- Design and implement a new module
405+
- Optimize database or backend architecture
406+
- Handle complex state management
407+
- Integrate third-party services
408+
- Major performance optimization tasks
409+
410+
---
411+
412+
### level: Critical
413+
414+
For high-priority or highly sensitive tasks that may impact important parts of the project.
415+
416+
#### What to Expect
417+
- Requires strong technical understanding
418+
- May affect security, stability, or core functionality
419+
- Needs careful testing and review
420+
421+
#### Criteria
422+
- Security-related fixes
423+
- Critical production bugs
424+
- Core architecture updates
425+
- High-impact system improvements
426+
427+
#### Example Issues
428+
- Fix authentication vulnerabilities
429+
- Resolve major backend crashes
430+
- Improve core system reliability
431+
- Handle critical deployment issues
432+
- Refactor sensitive infrastructure code
433+
434+
---
435+
436+
## Recommendation for New Contributors
437+
438+
If you are contributing for the first time, we strongly recommend starting with **level: Beginner** issues.
439+
These tasks are beginner-friendly and help you understand the project structure, contribution workflow, and coding style before moving to more advanced issues.
440+
441+
Once you feel comfortable, you can gradually try `level:intermediate`, `level:advanced`, and `level:critical` tasks.
332442

333443
## 🤔 Questions?
334444

0 commit comments

Comments
 (0)