Skip to main content
For each pull request, Macroscope generates a succinct summary and suggests where reviewers should begin their review.
When changes are made to a pull request (e.g. a new commit), Macroscope automatically updates its PR description to include the latest changes.
By connecting Macroscope to your issue tracker, Macroscope can use ticket context — including related commits and issue metadata — to generate better code summaries.

​
Where Pull Request Summaries Show Up in GitHub

If the PR has no description, Macroscope will automatically add its summary directly to the PR description. If the author has already written a PR description, Macroscope posts its summary as a comment—never overwriting the author’s text.

​
Inserting Macroscope Summaries into Your PR Templates

If you want Macroscope to add its summaries into your PR template, you can add the following start and end markers, exactly as they appear below, anywhere within a PR template. 
<!-- Macroscope's pull request summary starts here -->
<!-- Macroscope's pull request summary ends here -->
Macroscope will replace everything between these markers with its generated summary. For example, a template might look something like this: 
## Why are we making this change?
Explain the motivation here.

## Pull Request Summary

<!-- Macroscope's pull request summary starts here -->

<!-- Macroscope's pull request summary ends here -->

## Implementation Details
- Key design decisions
- Trade-offs
- Edge cases considered

## Checklist
- [ ] Code compiles and passes tests
- [ ] Documentation updated
- [ ] Security considerations reviewed
The markers themselves are invisible in GitHub’s rendered markdown, so reviewers will only see Macroscope’s PR summary in that section. If you remove either the start or end marker, Macroscope will post its summary as a separate comment instead.
You can also include extra context inside the markers if it helps improve readability. Macroscope will replace everything within the markers.