pr-description-generator

Generate pull request descriptions automatically by reading project documentation like README.md and analyzing git diffs to output a structured narrative with summaries, changed files, and test plans. The tool extracts project goals and composes a complete PR description from the analyzed code changes.

Yes, you can use project documentation like spec.md to write consistent PR descriptions. The generator reads files such as context.md and spec.md to extract decisions and scope, ensuring the resulting PR description aligns with your project's documented goals and requirements.

The best way to structure a PR description is to include Summary, Files Changed, Test Plan, Quality Checklist, and related issues sections. This structured format ensures uniform communication and captures the full impact of code changes across software projects.

Yes, the PR description generator works for both new PRs and update PRs. It is applicable across software projects whenever a Git history exists alongside documentation, allowing it to capture diffs and affected files for any code modification.

While having documentation files like README.md, spec.md, or context.md enhances the context, the generator analyzes git changes to capture diffs and affected files regardless. Project documentation is read to extract goals and decisions, improving the quality of the structured PR output.

Automating PR documentation saves time and ensures uniform communication across software projects. Manually writing descriptions often leads to inconsistent formatting, whereas an automated generator reads project docs and git diffs to consistently output standardized sections like Test Plans and Quality Checklists.