jerryshao opened a new issue, #10875:
URL: https://github.com/apache/gravitino/issues/10875

   ## What would you like to be improved?
   
   Gravitino has shifted to spec-driven programming requiring design doc PRs 
before major feature implementation. However, there is no enforced structure 
for design documents — authors write in their own style, leading to 
inconsistent quality and missing sections (e.g. no alternatives investigated, 
vague goals, missing task breakdown). Reviewers spend time asking for the same 
structural fixes on every design doc PR.
   
   ## How should we improve?
   
   Add a `gravitino-design-doc` Claude Code skill under `agent-skills/` that 
enforces a consistent structure and content quality for design documents. The 
skill guides authors while writing and lets reviewers check docs against a 
quality checklist.
   
   Required sections enforced by the skill:
   1. Apache License Header
   2. Title
   3. Background — current state and problem, not the solution
   4. Goals — concrete and verifiable, not vague
   5. Non-Goals — explicit scope carve-outs with rationale
   6. Solution Investigations — alternatives considered with pros/cons and 
rejection reasons
   7. Proposal — API design, data model, implementation approach
   8. Task Breakdown — one actionable task per GitHub issue/PR, ordered by 
dependency


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to