Skip to content

LABEL_GUIDE.md

Latest commit

 

History

History
90 lines (59 loc) · 3.79 KB

LABEL_GUIDE.md

File metadata and controls

90 lines (59 loc) · 3.79 KB

🏷️ Project Labeling Guide

A standardized labeling system to organize issues and pull requests efficiently.

Issues Contributions Maintained

📌 Overview

This labeling system helps:

  • 📂 Organize issues clearly
  • 🧠 Match contributors with suitable tasks
  • ⚡ Improve project workflow and collaboration

🧩 Label Categories

1️⃣ Type Labels

Define what the issue is about

Label Badge Description Usage
bug Something isn't working Reproducible errors or unexpected behavior
enhancement New feature or request Improvements to existing logic
documentation Documentation updates README, Wiki, comments
refactor Code cleanup Restructuring without behavior change
testing Tests Unit or integration tests

2️⃣ Priority Labels

Define urgency level

Label Badge Description
priority: high 🚨 Critical (e.g., crashes)
priority: medium ⚠️ Important, not urgent
priority: low 💡 Minor improvements

3️⃣ Experience Levels

Help contributors pick tasks based on skill level

Label Badge Description
good first issue 🟢 Beginner-friendly
intermediate 🟡 Some experience needed
help wanted 🔵 Complex tasks

4️⃣ Status Labels

Track progress of issues/PRs

Label Badge Description
status: blocked ⛔ Waiting on dependency
status: in-progress 🚧 Being worked on
status: review-needed 👀 Needs review
invalid / wontfix ❌ Not valid / out of scope

🛠️ Contribution Workflow

👨‍💻 For Contributors

🔍 Find a Task

  • Filter issues by:
    • good first issue
    • help wanted

💬 Express Interest

Comment on the issue:

I'm interested in this!