PR & Review Templates

How Opulent discovers and uses GitHub-style pull request templates, including the custom Opulent template filename for agent-authored work.

Opulent can use GitHub-style pull request templates. It looks in your repository for the first matching template file and uses it when generating or regenerating a PR description. In addition to the standard GitHub filenames, Opulent also supports an Opulent-specific variant so you can give the Autonomous Knowledge Worker a different template than your human authors use.

1. Discovery Order

First match wins (top to bottom):

PULL_REQUEST_TEMPLATE/OPULENT_PR_TEMPLATE.md
docs/PULL_REQUEST_TEMPLATE/OPULENT_PR_TEMPLATE.md
.github/PULL_REQUEST_TEMPLATE/OPULENT_PR_TEMPLATE.md
PULL_REQUEST_TEMPLATE/opulent_pr_template.md
docs/PULL_REQUEST_TEMPLATE/opulent_pr_template.md
.github/PULL_REQUEST_TEMPLATE/opulent_pr_template.md
PULL_REQUEST_TEMPLATE.md
pull_request_template.md
docs/PULL_REQUEST_TEMPLATE.md
docs/pull_request_template.md
.github/PULL_REQUEST_TEMPLATE.md
.github/pull_request_template.md

The entries with OPULENT_PR_TEMPLATE.md and opulent_pr_template.md are optional Opulent-specific overrides (both uppercase and lowercase variants are supported). If none exist, the standard PULL_REQUEST_TEMPLATE.md and pull_request_template.md locations are used. If nothing matches, Opulent falls back to its built-in default structure.

2. Custom Opulent Template (optional)

Add an Opulent-only template for agent-authored work by creating one of:

.github/PULL_REQUEST_TEMPLATE/OPULENT_PR_TEMPLATE.md
.github/PULL_REQUEST_TEMPLATE/opulent_pr_template.md
docs/PULL_REQUEST_TEMPLATE/OPULENT_PR_TEMPLATE.md
docs/PULL_REQUEST_TEMPLATE/opulent_pr_template.md
PULL_REQUEST_TEMPLATE/OPULENT_PR_TEMPLATE.md
PULL_REQUEST_TEMPLATE/opulent_pr_template.md

Use this if you want Opulent to include extra structure (e.g. risk checklist hints, review-evidence links) without changing what humans see in their usual PULL_REQUEST_TEMPLATE.md or pull_request_template.md. Both uppercase and lowercase variants are supported.

If you prefer a single shared template, just keep (or add):

.github/pull_request_template.md

Placeholders and HTML comments will be cleaned up naturally.

3. Built-in Default (if no file found)

If no template file exists, Opulent uses an internal default with sections for:

• Summary
• Review & Testing Checklist
• (Optional) Mermaid diagram
• Notes

You do not need to copy this unless you want to customize it; supplying any of the supported files above completely replaces the default.

4. GitHub Reference

Opulent follows GitHub's single-file template resolution rules. For more about GitHub PR templates (including multi-template workflows), see here.

---

Minimal setup to give Opulent its own template:

mkdir -p .github/PULL_REQUEST_TEMPLATE
echo "# [title]\n\n## Summary\n...\n" > .github/PULL_REQUEST_TEMPLATE/opulent_pr_template.md

That's it — open or regenerate a PR and Opulent will use it.