Skip to content

LABELS.md

Latest commit

 

History

History
140 lines (106 loc) · 3.46 KB

LABELS.md

File metadata and controls

140 lines (106 loc) · 3.46 KB
Raw

🏷️ GitHub Labels Strategy

A consistent label taxonomy keeps the repo organized for 50+ contributors.

🎨 Color Scheme

Color Hex Usage
🟢 Green #2cbe4e Good first issue, help wanted
🔵 Blue #1d76db Module labels (backend, devops, etc.)
🟠 Orange #fbca04 Type labels (docs, enhancement, bug)
🔴 Red #e11d21 Priority labels (high, critical)
⚫ Gray #bfdadc Status labels (needs-review, blocked)
🟣 Purple #b60205 Difficulty labels (easy, medium, hard)

🏷️ Label Taxonomy

1. Module Labels (Blue)

Label Description
module/backend-systems Backend systems patterns
module/devops-infrastructure DevOps & infrastructure patterns
module/data-engineering Data engineering patterns
module/system-design System design patterns
module/ml-systems ML systems patterns
module/security-patterns Security patterns
module/new-module Proposal for a new module

2. Type Labels (Orange)

Label Description
type/new-pattern Adding a new pattern
type/new-example Adding code examples
type/docs Documentation improvements
type/bug Bug in existing code
type/enhancement Improve existing pattern
type/translation Language translation
type/discussion RFC or proposal

3. Difficulty Labels (Purple)

Label Description
difficulty/easy Docs, small fixes (~30 min)
difficulty/medium New examples, pattern expansion (~2h)
difficulty/hard New module, complex implementation (~1d)

4. Priority Labels (Red)

Label Description
priority/low Nice to have
priority/medium Important but non-urgent
priority/high Blocking release or major gap
priority/critical Security issue or broken example

5. Status Labels (Gray)

Label Description
status/needs-review PR awaiting maintainer review
status/needs-revision Changes requested by maintainer
status/blocked Waiting on external dependency
status/stale No activity for 30 days
status/duplicate Already covered by another issue/PR

6. Special Labels (Green)

Label Description
good first issue Beginner-friendly issue
help wanted Looking for contributors
hacktoberfest Eligible for Hacktoberfest
hacktoberfest-accepted PR merged during Hacktoberfest

🔧 Repository Settings

Issue Labels (Required)

module/*
type/*
difficulty/*
priority/*
status/*
good first issue
help wanted
hacktoberfest

Pull Request Labels (Required)

status/needs-review
status/needs-revision
hacktoberfest-accepted

📋 Automation

Use a GitHub Action (labeler.yml) to auto-label PRs based on paths:

# .github/labeler.yml
"module/backend-systems":
  - backend-systems/**/*

"module/devops-infrastructure":
  - devops-infrastructure/**/*

"type/new-example":
  - "**/examples/*"

"type/docs":
  - "**/*.md"

📊 Label Stats

Category Labels Purpose
Module 8 Which part of the repo
Type 8 What kind of change
Difficulty 3 How hard
Priority 4 How urgent
Status 5 Current state
Special 4 Contributor-facing
Total 32