Merge pull request #1 from Yana-do-code/docs-issue-labels

Add issue and pull request labeling guidelines

Author: himanshujays29

issue-labels.md

@@ -0,0 +1,120 @@
+# ISSUE & PULL REQUEST LABELING GUIDELINES
+
+**Repository:** CircuitVerseDocs  
+**Website:** https://docs.circuitverse.org/
+
+---
+
+## OVERVIEW
+
+This document defines the labeling system used for issues and pull requests in the **CircuitVerseDocs** repository.  
+The purpose of these labels is to organize documentation-related work, improve issue visibility, and make collaboration easier for contributors and maintainers.
+
+This repository primarily deals with **documentation content** and **documentation site UI/UX**, so labels focus on content accuracy, completeness, and usability.
+
+Labels should be applied only after:
+
+- Verifying the issue is relevant to documentation
+- Checking for existing or related issues
+- Ensuring the issue addresses a single concern
+
+Issues covering multiple concerns should be split for clarity.
+
+---
+
+## ISSUE LIFECYCLE / WORKFLOW LABELS
+
+These labels describe the current status of an issue.
+
+| Label | Description |
+|------|------------|
+| `Pending` | Issue has been reported but not yet reviewed or categorized. |
+| `In progress` | Someone is actively working on resolving the issue. |
+| `Blocked` | Progress is blocked due to missing information, decisions, or dependencies. |
+| `Duplicate` | Issue already exists and is tracked elsewhere. |
+
+---
+
+## DOCUMENTATION ISSUE TYPE LABELS
+
+These labels describe the nature of the documentation issue or change.
+
+| Label | Description |
+|------|------------|
+| `Missing content` | Required documentation pages, sections, or explanations are missing. |
+| `Incorrect content` | Information is inaccurate, outdated, or misleading. |
+| `Documentation` | General documentation-related updates or fixes. |
+| `Enhancement` | Improvements to clarity, structure, or examples. |
+| `UI/UX` | Layout, readability, navigation, or visual issues on the docs site. |
+| `Formatting` | Markdown, styling, or layout inconsistencies. |
+| `Broken link` | Links that are broken, outdated, or redirect incorrectly. |
+| `Accessibility` | Issues affecting usability for all users, including screen readers. |
+| `Invalid` | Issue is not applicable, unclear, or outside the documentation scope. |
+
+---
+
+## PLATFORM / SITE AREA LABELS
+
+These labels indicate which part of the documentation site is affected.
+
+| Label | Description |
+|------|------------|
+| `Docs website` | Global site layout, navigation, or theme-related issues. |
+| `Guides` | Tutorials, walkthroughs, or learning-oriented content. |
+| `Reference` | Feature references, explanations, or technical documentation. |
+| `Getting started` | Beginner onboarding and introductory documentation. |
+
+---
+
+## CONTRIBUTOR-FRIENDLY LABELS
+
+These labels help contributors identify suitable issues.
+
+| Label | Description |
+|------|------------|
+| `good first issue` | Simple, well-defined issues suitable for first-time contributors. |
+| `Needs help` | Maintainers are actively seeking community contributions. |
+
+---
+
+## EFFORT / SCOPE ESTIMATION LABELS
+
+These labels indicate the approximate level of effort required.
+
+| Label | Description |
+|------|------------|
+| `Small` | Minor edits or straightforward fixes. |
+| `Medium` | Moderate work such as adding sections or restructuring content. |
+| `Large` | Major documentation additions or multi-page updates. |
+
+---
+
+## PULL REQUEST LABELS
+
+### PR REVIEW STATUS
+
+| Label | Description |
+|------|------------|
+| `Review-ready` | Pull request is complete and ready for review. |
+| `Approved` | Pull request has been reviewed and approved. |
+
+---
+
+### PR PRIORITY LEVELS
+
+| Label | Description |
+|------|------------|
+| `urgent` | Urgent documentation issue requiring immediate attention. |
+| `Priority-High` | High-priority improvement but not blocking usage. |
+| `Priority-Normal` | Normal priority documentation work. |
+
+---
+
+## GENERAL GUIDELINES
+
+- Multiple labels may be applied when appropriate, but over-labeling should be avoided.
+- Workflow and scope labels should be updated as issues progress.
+- Resolution-related labels such as `Invalid` or `Duplicate` should be applied before closing issues.
+- Consistent label usage improves discoverability and contributor experience.
+
+---