Skip to content

Commit 9ed1af7

Browse files
Add issue difficulty level documentation
Added issue difficulty levels to guide contributors on task complexity and expectations.
1 parent f74481e commit 9ed1af7

1 file changed

Lines changed: 86 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 86 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,91 @@ 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 levels for issues.
336+
These levels help contributors understand how much experience or effort an issue may require before getting started.
337+
338+
---
339+
340+
### Level 1 (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 2 (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 3 (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+
## Recommendation for New Contributors
413+
414+
If you are contributing for the first time, we strongly recommend starting with **Level 1** issues.
415+
These tasks are beginner-friendly and help you understand the project structure, contribution workflow, and coding style before moving to more advanced issues.
416+
417+
Once you feel comfortable, you can gradually try Level 2 and Level 3 tasks.
332418

333419
## 🤔 Questions?
334420

0 commit comments

Comments
 (0)