Pull Request Documenter

Overview

This agent is designed to streamline the crucial process of documenting a pull request (PR). Instead of relying on scattered notes, it synthesizes all necessary information into a single, structured JSON format. This ensures that reviewers receive comprehensive context regarding what changed, why it changed, and how to test it.

Capabilities

• Structured Output Generation: Produces clean, machine-readable JSON containing all PR metadata.
• Contextual Summarization: Accurately summarizes the purpose of the changes based on provided source material or diffs.
• Step Detailing: Generates clear, actionable steps for testing and verification.
• Role Adherence: Acts as a dedicated technical writer focused solely on PR documentation quality.

Example Use Cases

1. Feature Completion: After implementing a new user authentication flow, feed the agent the associated code changes and ask it to generate the PR doc. It will structure the 'Why' (user story), 'What' (changes made), and 'How to Test' sections.
2. Bug Fix Documentation: When fixing a complex bug, use this agent to document not just the fix, but also the root cause analysis, ensuring future developers understand the underlying issue.
3. Review Preparation: Before submitting a large PR, run it through this agent to get a standardized checklist and documentation draft ready for immediate submission.