Repository navigation
docs(#685): Wave 5.2.4 - Update Supporting Documentation - #695
Conversation
Update all supporting documentation to reflect standardizations from Wave 5.2.1-5.2.3: Changes: - ISSUE_TYPES.md: Updated display names to standardized noun forms * 'Code Refactor' → 'Refactor' * 'Build & CI' → 'Build' * 'Test Coverage' → 'Testing' * 'A11y' → 'Accessibility' * 'Code Review' → 'Review' - ISSUE-FIELDS.md: Updated issue type list with standardized names - Added Wave 5.2.3-5.2.4 update notes explaining standardization rationale Rationale: Documentation now reflects the standardized issue-type naming implemented in Wave 5.2.3, with canonical references updated across all governance documents. https://claude.ai/code/session_01QBPjNAFgVUmE7RP658hut9
|
Warning Review limit reached
More reviews will be available in 2 minutes and 14 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Repository YAML (base), Organization UI (inherited) Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
✨ 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 |
github-actions
Bot
added
area:labels
🔍 Reviewer Summary for PR #695CI Status: ✅ Recommendations
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request standardizes issue-type display names across documentation files to use consistent noun forms (such as 'Refactor', 'Build', 'Testing', 'Accessibility', and 'Review') and documents these updates in docs/ISSUE_TYPES.md. Feedback on the changes suggests renaming docs/ISSUE-FIELDS.md to docs/ISSUE_FIELDS.md to adhere to uppercase-with-underscores naming conventions and prevent validation script failures, as well as adding missing 'Question' and 'Support' types to the covered list.
| - Task, Bug, Feature, Refactor, Build, Accessibility, Compatibility, Security, Release | ||
| - Maintenance, Performance, Testing, Epic, Automation, Review, Design, Story |
There was a problem hiding this comment.
The file docs/ISSUE-FIELDS.md uses a hyphen in its filename, which violates the repository's general rule for documentation and governance files in the docs/ directory (which must use UPPERCASE naming with underscores, e.g., GOVERNANCE_REVISION_LOG.md). Additionally, the validation script scripts/validation/validate-issue-fields.cjs expects the file to be named docs/ISSUE_FIELDS.md (line 9), meaning the validation will fail if the file is not renamed.
Please rename docs/ISSUE-FIELDS.md to docs/ISSUE_FIELDS.md.
Also, the list of covered issue types is missing Question and Support (to match the 27 types defined in docs/ISSUE_TYPES.md). We can add them to line 111 to make the list complete.
| - Task, Bug, Feature, Refactor, Build, Accessibility, Compatibility, Security, Release | |
| - Maintenance, Performance, Testing, Epic, Automation, Review, Design, Story | |
| - Task, Bug, Feature, Refactor, Build, Accessibility, Compatibility, Security, Release | |
| - Maintenance, Performance, Testing, Epic, Automation, Review, Design, Story, Question, Support |
References
- Documentation and governance files in the
docs/directory must use UPPERCASE naming with underscores (e.g.,GOVERNANCE_REVISION_LOG.md), as the lowercase-with-hyphens naming convention applies to other asset types and not todocs/files.
The file docs/ISSUE-FIELDS.md uses hyphenated naming which violates repository convention. The canonical file is docs/ISSUE_FIELDS.md (underscore naming) which was updated in Wave 5.2.2. This commit removes the incorrectly-named duplicate file. The ISSUE_TYPES.md updates from the previous commit are correct and complete.
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 512d65648e
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| - `Code Refactor` → `Refactor` (noun form, consistent with other types) | ||
| - `Build & CI` → `Build` (simplified, noun form) | ||
| - `Test Coverage` → `Testing` (noun form) | ||
| - `A11y` → `Accessibility` (full accessible name, noun form) | ||
| - `Code Review` → `Review` (simplified, noun form) |
There was a problem hiding this comment.
When anyone follows this guide or reruns the documentation generator, these new display names do not match the actual source of truth: in this same commit, .github/issue-types.yml and .github/issue-fields.yml still list Code Refactor, Build & CI, Test Coverage, A11y, and Code Review, and scripts/consolidate-issue-types.js still emits the old names. Because the note above says issue-types.yml is the canonical mapping used by automation, the docs now instruct users to look for Type values the automation/config does not provide; update the canonical config and generator as part of this change, or keep the docs aligned with the existing names.
Useful? React with 👍 / 👎.
| @@ -1,196 +0,0 @@ | |||
| # Canonical Issue Fields | |||
There was a problem hiding this comment.
Deleting this file leaves existing repository links pointing at a missing document; rg ISSUE-FIELDS still finds live references in docs/README.md and instructions/issues.instructions.md that direct readers to docs/ISSUE-FIELDS.md. In contexts where contributors use the docs index or issue-triage instructions, those links now 404 instead of reaching the issue-field guidance, so either keep a redirect/stub here or update all references to the remaining docs/ISSUE_FIELDS.md.
Useful? React with 👍 / 👎.
Summary
Updates supporting documentation to reflect the standardized issue-type display names from Wave 5.2.3 (#684).
Changes:
docs/ISSUE_TYPES.md(v2.1 → v2.2) with standardized namesdocs/ISSUE-FIELDS.md(older file) for consistencyRelated: Issue #685, Wave 5.2 canonical config audit (#650)
Definition of Done
Generated by Claude Code