Problem
Creating new Pull Requests doesn't ask for any information about the change. This can have an ambiguous affect on AI agents which might rely on the PR description for context of change. Linking a PR to issues helps, but context is still missing about what the intent of the change might be.
Proposed Solution
Add a Pull Request Template file that is tuned for both Human and AI reviewers to read. Include the following sections:
- Summary (1-2 sentences of what the intent of the change is)
- Key Changes (list of high level changes, e.g. features, fixes)
- Links (list of links to issues or external sites such as Jira tickets, including annotations for the relationship e.g. "Fixes #{issue-number}"
Notes
The template should give maximum high level context to both humans and code review agents. It should not include implementation detail, as this might split the source of truth. The PR description is a declaration of intent, with the code being the source of truth for the actual change.
Problem
Creating new Pull Requests doesn't ask for any information about the change. This can have an ambiguous affect on AI agents which might rely on the PR description for context of change. Linking a PR to issues helps, but context is still missing about what the intent of the change might be.
Proposed Solution
Add a Pull Request Template file that is tuned for both Human and AI reviewers to read. Include the following sections:
Notes
The template should give maximum high level context to both humans and code review agents. It should not include implementation detail, as this might split the source of truth. The PR description is a declaration of intent, with the code being the source of truth for the actual change.