-
Notifications
You must be signed in to change notification settings - Fork 245
feat: [docs] Add issue triaging file explaining all labels used #915
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
ShinichiShi
wants to merge
13
commits into
CircuitVerse:main
Choose a base branch
from
ShinichiShi:docs-issue-triage
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 7 commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
4d9dc02
feat: add issue triage documentation
ShinichiShi 717c7d1
fix: rename labels
ShinichiShi 1cb053f
fix: file heading
ShinichiShi d24ef44
fix: add coderabbit addressing
ShinichiShi 63ffab7
fix: use specific label headings
ShinichiShi 7bcbb7f
Merge branch 'main' into docs-issue-triage
ShinichiShi ba7052b
fix: coderabbit suggestion lowercase the labels
ShinichiShi 26d35e6
fix: add coderabbit suggestions
ShinichiShi ba81d44
Merge branch 'main' into docs-issue-triage
ShinichiShi 7e21516
feat: add pr-metadata-needs-fix label
ShinichiShi 02e611d
fix: remove android label
ShinichiShi 59d5164
add issue-metadata-needs-fix label
ShinichiShi cdf7d84
Merge branch 'main' into docs-issue-triage
ShinichiShi File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| # Issue & PR Label Guide | ||
|
|
||
| This document defines the labeling system used for issues and pull requests in the **cv-frontend-vue** repository. | ||
| The goal is to ensure consistent triaging, improve issue clarity, and make it easier for contributors and maintainers to collaborate effectively. | ||
|
|
||
| Labels are applied after verifying reproducibility, checking for duplicates, and ensuring each issue addresses a single concern. Issues covering multiple concerns may be split for clarity. | ||
|
|
||
| --- | ||
|
|
||
| ## Status Labels | ||
|
|
||
| These labels represent the **current lifecycle state** of an issue. | ||
|
|
||
| | Label | Description | | ||
| |------|------------| | ||
| | `pending` | Issue has been reported and is awaiting initial triage. | | ||
| | `in progress` | Work on the issue has started. | | ||
| | `blocked` | Progress is blocked due to a dependency or external factor. | | ||
| | `duplicate` | The issue has already been reported and is tracked elsewhere. | | ||
| | `stale` | No activity for an extended period; may be closed if no updates occur. | | ||
|
|
||
| --- | ||
|
|
||
| ## Type Labels | ||
|
|
||
| These labels describe **the nature of the issue**. | ||
|
|
||
| | Label | Description | | ||
| |------|------------| | ||
| | `bug` | Something is broken or not functioning as intended. | | ||
| | `feature` | Request for new functionality or capability. | | ||
| | `enhancement` | Improvement to an existing feature or behavior. | | ||
| | `documentation` | Issues related to documentation, guides, or comments. | | ||
| | `ui/ux` | User interface or user experience related issues. | | ||
coderabbitai[bot] marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| | `security` | Issues that may impact application or user security. | | ||
| | `breaking change` | Changes that may break existing functionality or backward compatibility. | | ||
|
|
||
| --- | ||
|
Comment on lines
+37
to
+38
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fix incomplete "either…or" construction and add missing blank line (MD058) after the Type Labels table. Two issues on this new row:
📝 Proposed fix-| `issue-metadata-needs-fix` | The issue template is either not followed correctly. Please update the issue description. |
-...
+| `issue-metadata-needs-fix` | The issue template is either not followed correctly or the provided information conflicts with the changes. Please update the issue description. |
+
---🧰 Tools🪛 markdownlint-cli2 (0.21.0)[warning] 37-37: Tables should be surrounded by blank lines (MD058, blanks-around-tables) 🤖 Prompt for AI Agents |
||
|
|
||
| ## Platform Labels | ||
|
|
||
| These labels indicate **where the issue applies**. | ||
|
|
||
| | Label | Description | | ||
| |------|------------| | ||
| | `tauri` | Issues related to the Tauri-based application layer. | | ||
| | `desktop` | Desktop-specific functionality or behavior. | | ||
|
|
||
| --- | ||
|
|
||
| ## Operating System Labels | ||
|
|
||
| Used when an issue is **OS-specific**. | ||
|
|
||
| | Label | Description | | ||
| |------|------------| | ||
| | `windows` | Issue specific to Windows environments. | | ||
| | `linux` | Issue specific to Linux environments. | | ||
| | `macos` | Issue specific to macOS environments. | | ||
|
|
||
| --- | ||
|
|
||
| ## Contributor-Friendly Labels | ||
|
|
||
| These labels help contributors discover suitable issues. | ||
|
|
||
| | Label | Description | | ||
| |------|------------| | ||
| | `good first issue` | Suitable for first-time contributors. | | ||
| | `help wanted` | Maintainers welcome contributions on this issue. | | ||
|
|
||
| --- | ||
|
|
||
| ## Time-Based Labels | ||
|
|
||
| These labels indicate **estimated effort or scope**. | ||
|
|
||
| | Label | Description | | ||
| |------|------------| | ||
| | `small` | Minor change, quick fix, or low-risk update. | | ||
| | `medium` | Requires moderate changes or understanding of the codebase. | | ||
| | `large` | Significant refactor, complex logic, or multi-file changes. | | ||
|
|
||
| --- | ||
|
|
||
| ## Pull Request Labels | ||
|
|
||
| ### PR Status | ||
|
|
||
| | Label | Description | | ||
| |------|------------| | ||
| | `review-ready` | Pull request is ready for review. This is added only after all the threads mentioned by CodeRabbit and reviewers have been addressed. | | ||
| | `approved` | Pull request has been reviewed and approved. | | ||
|
|
||
| ### PR Priority | ||
|
|
||
| | Label | Description | | ||
| |------|------------| | ||
| | `p0` | Critical fix; requires immediate attention. | | ||
| | `p1` | High priority but not blocking. | | ||
| | `p2` | Normal priority. | | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.