-
Notifications
You must be signed in to change notification settings - Fork 135
docs: add Issue & PR Label Guide to project documentation #490
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
base: master
Are you sure you want to change the base?
docs: add Issue & PR Label Guide to project documentation #490
Conversation
✅ Deploy Preview for cv-mobile-app-web ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
WalkthroughThis pull request introduces a new markdown documentation file that catalogs the labeling system for issues and pull requests in the repository. The file defines label categories including status (pending, in progress, blocked, duplicate, stale), type (bug, feature, enhancement, documentation, ui/ux, security, breaking change), platform (flutter, android, ios, web), operating system (windows, linux, macos), contributor-friendly designations (good first issue, help wanted), effort estimates (small, medium, large), PR-specific labels (review-ready, approved), PR priority levels (p0, p1, p2), and Flutter-specific tags (dart, state-mgmt, navigation, performance, localization, testing). The document includes usage guidance and detailed table-based descriptions for each label category. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this 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_label.md`:
- Around line 112-114: The phrase in the table row for the `state-mgmt` label
uses "State management related issues"; update that description to use a
hyphenated compound adjective: change the text for the `state-mgmt` row to
"state management–related issues" (preserve the backticks around `state-mgmt`
and the table formatting).
| | `dart` | Issues related to Dart language features. | | ||
| | `state-mgmt` | State management related issues. | | ||
| | `navigation` | Navigation and routing related issues. | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hyphenate the compound adjective.
“State management related issues” reads better as “state management–related issues.”
✏️ Suggested edit
-| `state-mgmt` | State management related issues. |
+| `state-mgmt` | State management–related issues. |📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| | `dart` | Issues related to Dart language features. | | |
| | `state-mgmt` | State management related issues. | | |
| | `navigation` | Navigation and routing related issues. | | |
| | `dart` | Issues related to Dart language features. | | |
| | `state-mgmt` | State management–related issues. | | |
| | `navigation` | Navigation and routing related issues. | |
🧰 Tools
🪛 LanguageTool
[grammar] ~113-~113: Use a hyphen to join words.
Context: ... | | state-mgmt | State management related issues. | | `navig...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
In `@issue_label.md` around lines 112 - 114, The phrase in the table row for the
`state-mgmt` label uses "State management related issues"; update that
description to use a hyphenated compound adjective: change the text for the
`state-mgmt` row to "state management–related issues" (preserve the backticks
around `state-mgmt` and the table formatting).
Fixes #489
Describe the changes you have made in this PR -
This PR adds a markdown file "issue-label.md" detailing the labeling system for issues and pull requests. The guide covers status, type, platform, OS, contributor-friendly, time-based, PR and Flutter-specific labels to improve project collaboration and clarity.
Summary by CodeRabbit
Release Notes