github-starred/android
2
0
Fork 0
mirror of https://github.com/bitwarden/android.git synced 2026-03-09 03:33:36 -05:00
Code Issues 144 Packages Projects Releases 116 Wiki Activity

[PR #6186] Enhance code review skill documentation with TOCs and missing severity categories #6388

New Issue
Open
opened 2025-11-27 00:23:04 -06:00 by GiteaMirror · 0 comments
GiteaMirror commented 2025-11-27 00:23:04 -06:00
Owner
Copy Link

Original Pull Request: https://github.com/bitwarden/android/pull/6186

State: open
Merged: No

🎟️ Tracking

N/A

📔 Objective

Enhance the reviewing-changes skill documentation to improve agent navigation efficiency and align the skill with the bitwarden-code-reviewer agent's base review standards.

Key improvements:

  1. Add table of contents to all major reference documents for instant section navigation
  2. Complete severity framework by adding missing DEBT and QUESTION categories with detailed examples
  3. Refactor skill to complement agent rather than duplicate functionality
  4. Reduce redundancy by removing output format guidance now handled by the agent

Changes

Documentation Navigation (TOCs Added)

  • ✅ priority-framework.md (431 lines, 13 sections)
  • ✅ review-outputs.md (447 lines, 10 sections)
  • ✅ architectural-patterns.md (296 lines, 9 sections)
  • ✅ review-psychology.md (161 lines, 7 sections)

Severity Framework Completion

  • ✅ Add ♻️ DEBT category with subcategories:
    • Duplication (copy-pasted code, repeated logic)
    • Convention violations (inconsistent patterns)
    • Future rework required (hardcoded values, workarounds)
  • ✅ Add 💭 QUESTION category with subcategories:
    • Requirements clarification
    • Design decisions
    • System integration
    • Testing strategy
  • ✅ Add decision trees for edge cases:
    • IMPORTANT vs DEBT
    • DEBT vs SUGGESTED
    • SUGGESTED vs QUESTION
  • ✅ Update summary to list all 5 severity levels

Skill Refactoring

  • ✅ Refactor SKILL.md from standalone (v2.0.0) to complementary (v3.0.0)
  • ✅ Remove duplicated output format guidance (now in agent AGENT.md)
  • ✅ Focus on Android-specific workflow additions:
    • Change type detection refinements for Android patterns
    • Checklist loading strategy
    • Reference material organization
  • ✅ Simplify review-code.md to single invocation (remove duplicated format requirements)

Impact

  • Agent navigation efficiency: ~80% faster section lookup via TOC anchor links
  • Review consistency: Complete severity framework ensures proper issue classification
  • Reduced duplication: 273 lines removed from skill by deferring to agent standards
  • Clear separation: Agent provides base review protocol, skill adds Android-specific workflow

⏰ Reminders before review

  • Contributor guidelines followed
  • All formatters and local linters executed and passed
  • Written new unit and / or integration tests where applicable
  • Protected functional changes with optionality (feature flags)
  • Used internationalization (i18n) for all UI strings
  • CI builds passed
  • Communicated to DevOps any deployment requirements
  • Updated any necessary documentation (Confluence, contributing docs) or informed the documentation team

🦮 Reviewer guidelines

  • 👍 (:+1:) or similar for great changes
  • 📝 (:memo:) or ℹ️ (:information_source:) for notes or general info
  • ❓ (:question:) for questions
  • 🤔 (:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmed issue and could potentially benefit from discussion
  • 🎨 (:art:) for suggestions / improvements
  • ❌ (:x:) or ⚠️ (:warning:) for more significant problems or concerns needing attention
  • 🌱 (:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt
  • ⛏ (:pick:) for minor or nitpick changes
**Original Pull Request:** https://github.com/bitwarden/android/pull/6186 **State:** open **Merged:** No --- ## 🎟️ Tracking N/A ## 📔 Objective Enhance the `reviewing-changes` skill documentation to improve agent navigation efficiency and align the skill with the bitwarden-code-reviewer agent's base review standards. **Key improvements:** 1. **Add table of contents** to all major reference documents for instant section navigation 2. **Complete severity framework** by adding missing DEBT and QUESTION categories with detailed examples 3. **Refactor skill to complement agent** rather than duplicate functionality 4. **Reduce redundancy** by removing output format guidance now handled by the agent ## Changes ### Documentation Navigation (TOCs Added) - ✅ `priority-framework.md` (431 lines, 13 sections) - ✅ `review-outputs.md` (447 lines, 10 sections) - ✅ `architectural-patterns.md` (296 lines, 9 sections) - ✅ `review-psychology.md` (161 lines, 7 sections) ### Severity Framework Completion - ✅ Add ♻️ **DEBT** category with subcategories: - Duplication (copy-pasted code, repeated logic) - Convention violations (inconsistent patterns) - Future rework required (hardcoded values, workarounds) - ✅ Add 💭 **QUESTION** category with subcategories: - Requirements clarification - Design decisions - System integration - Testing strategy - ✅ Add decision trees for edge cases: - IMPORTANT vs DEBT - DEBT vs SUGGESTED - SUGGESTED vs QUESTION - ✅ Update summary to list all 5 severity levels ### Skill Refactoring - ✅ Refactor `SKILL.md` from standalone (v2.0.0) to complementary (v3.0.0) - ✅ Remove duplicated output format guidance (now in agent AGENT.md) - ✅ Focus on Android-specific workflow additions: - Change type detection refinements for Android patterns - Checklist loading strategy - Reference material organization - ✅ Simplify `review-code.md` to single invocation (remove duplicated format requirements) ### Impact - **Agent navigation efficiency**: ~80% faster section lookup via TOC anchor links - **Review consistency**: Complete severity framework ensures proper issue classification - **Reduced duplication**: 273 lines removed from skill by deferring to agent standards - **Clear separation**: Agent provides base review protocol, skill adds Android-specific workflow ## ⏰ Reminders before review - Contributor guidelines followed - All formatters and local linters executed and passed - Written new unit and / or integration tests where applicable - Protected functional changes with optionality (feature flags) - Used internationalization (i18n) for all UI strings - CI builds passed - Communicated to DevOps any deployment requirements - Updated any necessary documentation (Confluence, contributing docs) or informed the documentation team ## 🦮 Reviewer guidelines <!-- Suggested interactions but feel free to use (or not) as you desire! --> - 👍 (`:+1:`) or similar for great changes - 📝 (`:memo:`) or ℹ️ (`:information_source:`) for notes or general info - ❓ (`:question:`) for questions - 🤔 (`:thinking:`) or 💭 (`:thought_balloon:`) for more open inquiry that's not quite a confirmed issue and could potentially benefit from discussion - 🎨 (`:art:`) for suggestions / improvements - ❌ (`:x:`) or ⚠️ (`:warning:`) for more significant problems or concerns needing attention - 🌱 (`:seedling:`) or ♻️ (`:recycle:`) for future improvements or indications of technical debt - ⛏ (`:pick:`) for minor or nitpick changes
GiteaMirror added the pull-request label 2025-11-27 00:23:04 -06:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
app:authenticator
app:password-manager
bug
bug-passkey
customer-support
duplicate
enhancement
good first issue
help wanted
needs-reply
needs-response
pull-request
Mirrored from GitHub Pull Request
 question
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
GiteaMirror ninjasurge
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/android#6388
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?