# Instant pull request template

The Instant Framework (theinstantframework.com) by Falcra (falcratechnologies.com)

A pull request template for AI-built software. One pull request per Unit of Work, summarised so a reviewer can judge it in minutes: which requirements it serves, what changed and why, its risk tier, the tests that prove it, the independent AI review and how its findings were resolved, every rule changed, and the Tweaks grouped as one line rather than hundreds.

Why it matters: an AI build produces changes faster than anyone can review them line by line. Most of those changes are Tweaks, small cosmetic adjustments your experts have already seen and accepted on screen. This template keeps them out of the reviewer's way and puts the attention where it belongs: the rules, the risk and the evidence.

## What's in the download

- `pull_request_template.md`: the template.
- `README.md`: this file.

## How to use it

1. **Add it to your repository** where your Git host looks for it:
   - GitHub: `.github/pull_request_template.md`
   - GitLab: `.gitlab/merge_request_templates/Default.md`
   - Azure DevOps: `.azuredevops/pull_request_template.md`
   - Bitbucket: paste it into the repository's default pull request description setting.
2. **Let the AI fill it in** when it raises the pull request for a Unit of Work. The Conductor checks it before anyone reviews.
3. **Review against it.** The reviewer works through the checklist at the end, to the depth the risk tier needs.

Adapt the headings to your own conventions. It works with or without the rest of Instant.

## Tweaks and rules

A **Tweak** is a small cosmetic change asked for in the room, such as a colour, a label, spacing or layout. It needs no story and no pull request of its own. A Tweak that changes behaviour isn't a Tweak: if a small request changes what data is shown, who can do what, a calculation, a status change or an automatic action, it's a rule. It goes under "Rules changed or added" with its decision reference.

## Licence

© 2026 What Did I Buy Online Pty Ltd, trading as Falcra. This template is licensed under the Creative Commons Attribution 4.0 International licence (CC BY 4.0), https://creativecommons.org/licenses/by/4.0/.

You may copy, change and share it, including commercially, provided you credit Falcra, link to the original and to the licence, and say if you changed it. A changed version must not suggest that Falcra made or endorses it.

Suggested credit: "Based on the Instant pull request template from The Instant Framework (theinstantframework.com) by Falcra (falcratechnologies.com), CC BY 4.0." Drop "Based on" if you share it unchanged.

Pull requests you write with it are yours. They don't need to carry the credit.
