Skip to content

feat : add issue triaging labels with their descriptions #511

Closed
Yana-do-code wants to merge 0 commit intoCircuitVerse:masterfrom
himanshujays29:master
Closed

feat : add issue triaging labels with their descriptions #511
Yana-do-code wants to merge 0 commit intoCircuitVerse:masterfrom
himanshujays29:master

Conversation

@Yana-do-code
Copy link
Copy Markdown
Contributor

@Yana-do-code Yana-do-code commented Feb 3, 2026

fix : #512

Describe the changes you have made in this PR -
This PR adds the issue-labels.md file which contains a brief description of all the labels that will be used in the cv docs repo .

Screenshots of the UI changes (If any) -

Code Understanding and AI Usage
Did you use AI assistance (ChatGPT, Claude, Copilot, etc.) to write any part of this code?

  • No, I wrote all the code myself
  • Yes, I used AI assistance (continue below)

If you used AI assistance:

  • I have reviewed every single line of the AI-generated code
  • I can explain the purpose and logic of each function/component I added
  • I have tested edge cases and understand how the code handles them
  • I have modified the AI output to follow this project's coding standards and conventions

Explain your implementation approach:

This PR focuses mainly to make it easier for new contributors to pick up the issues.

Checklist before requesting a review

  • I have added proper PR title and linked to the issue
  • I have performed a self-review of my code
  • I can explain the purpose of every function, class, and logic block I added
  • I understand why my changes work and have tested them thoroughly
  • I have considered potential edge cases and how my code handles them
  • If it is a core feature, I have added thorough tests
  • My code follows the project's style guidelines and conventions
    Note: Please check Allow edits from maintainers if you would like us to assist in the PR.

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive ISSUE & PULL REQUEST LABELING GUIDELINES document: a taxonomy for lifecycle/workflow labels (pending, in progress, blocked, duplicate), issue types (missing/incorrect content, docs, feature, enhancement, UI/UX, formatting, broken link, accessibility, invalid), platform areas (docs site, guides, reference, getting started), contributor markers (good first issue, needs help), effort estimates (small/medium/large), PR states/priorities (review-ready, approved, p0–p2), a translation label, and label-usage rules.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Feb 3, 2026

Walkthrough

Adds a new Markdown document titled "ISSUE & PULL REQUEST LABELING GUIDELINES" for CircuitVerseDocs. Defines a labeling taxonomy covering issue lifecycle labels (pending, in progress, blocked, duplicate), documentation issue types (missing content, incorrect content, documentation, feature, enhancement, ui/ux, formatting, broken link, accessibility, invalid), platform/site area labels (docs website, guides, reference, getting started), contributor-friendly labels (good first issue, needs help), effort/scope estimates (small, medium, large), PR labels and priorities (review-ready, approved, p0/p1/p2), a translation label, and rules for label order, scope, and consistency.

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: adding a new document that defines issue and PR labeling guidelines with descriptions for the CircuitVerseDocs repository.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@issue-labels.md`:
- Around line 126-129: The document references resolution labels with TitleCase
(`Invalid`, `Duplicate`) but the label table uses lowercase (`invalid`,
`duplicate`), causing a mismatch; update all occurrences so the casing is
consistent (either change the table entries to `Invalid` and `Duplicate` or
change the references to `invalid` and `duplicate`)—search for the strings
"Invalid", "Duplicate", "invalid", and "duplicate" in the file and make them
consistent throughout (including the label table and guideline bullets) so
GitHub label usage matches the documented names.

Comment thread issue-labels.md Outdated
@Yana-do-code
Copy link
Copy Markdown
Contributor Author

@tachyons @Nihal4777 kindly review it .

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Adding standardized Issue & Pull Request Labeling System for CircuitVerseDocs

2 participants