chore: add PR template

[0xgleb]

Motivation

The repo had no PR template, so PRs opened with empty or auto-generated bodies
(several in this stack did) and descriptions drifted to ad hoc formats. A
checked-in template gives every new PR a consistent skeleton.

Solution

• Adds .github/PULL_REQUEST_TEMPLATE.md with ## Motivation and ## Solution
  sections plus short guidance comments.
• GitHub applies it as the default body for new PRs once this merges to master.

Standalone chore; sits below the jobs ADR stack on chore/bump-up-cqrs-es.

Summary by CodeRabbit

• Chores
  • Updated the pull request template to add structured "Motivation" and "Solution" sections plus inline guidance prompting authors to explain need, design approach, edge cases, trade-offs, and include supporting links.

Closes RAI-920.

[0xgleb]

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

• adr: gradual consumer migration from services to jobs #19
• docs: migrate docs to the jobs model #20
• feat: migrate examples to the jobs model #16
• feat: replace EventSourced::Services with Jobs and wire atomic enqueue #15
• feat: add buffered JobQueue and apalis enqueue #14
• feat: add build_supervised_worker macro #13
• feat: job worker #12
• feat: add job module #11
• adr: jobs replace services #8
• chore: add PR template #17 👈 (View in Graphite)
• fix: sqlite-es snapshot sequence #18
• chore: bump up cqrs-es (0.5) #10
• chore: bump up deps (sqlx 0.9) #9
• master

---

How to use the Graphite Merge Queue

Add the label add-to-gt-merge-queue to this PR to add it to the merge queue.

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has required the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

[coderabbitai]

Walkthrough

This PR introduces a pull request template file at .github/PULL_REQUEST_TEMPLATE.md. The template includes "Motivation" and "Solution" sections with embedded guidance comments prompting authors to explain their approach, handle edge cases, and link supporting issues or context.

Changes

PR Template Setup

Layer / File(s)	Summary
Pull request template sections and guidance .github/PULL_REQUEST_TEMPLATE.md	Template file defines Motivation and Solution section headers with instructional comments guiding authors to document approach, edge cases, and issue linkage.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main change: adding a PR template to the repository's .github directory.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch chore/pr-template

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[linear-code]

RAI-920

[findolor]

Approved.

[graphite-app]

Merge activity

• Jun 10, 7:16 PM UTC: Graphite rebased this pull request, because this pull request is set to merge when ready.
• Jun 10, 7:22 PM UTC: 0xgleb added this pull request to the Graphite merge queue.
• Jun 10, 7:22 PM UTC: CI is running for this pull request on a draft pull request (#23) due to your merge queue CI optimization settings.
• Jun 10, 7:43 PM UTC: Merged by the Graphite merge queue via draft PR: #23.

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.github/PULL_REQUEST_TEMPLATE.md:
- Line 1: The markdownlint warning MD041 for the template heading is a false
positive; suppress it either globally by adding a config that sets "MD041":
false in your markdownlint config (e.g., .markdownlint.json) or locally by
adding an inline file-level disable comment at the top of the template (e.g.,
add <!-- markdownlint-disable MD041 --> before the existing "## Motivation"
heading) so the lint tool ignores the missing H1 for this PR template.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: ff5c87b2-4cfe-4b80-b1a7-f9362228d20a

📥 Commits

Reviewing files that changed from the base of the PR and between 5b1ff80 and b9ffe93.

📒 Files selected for processing (1)

• .github/PULL_REQUEST_TEMPLATE.md

📜 Review details

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (12)

• GitHub Check: hooks
• GitHub Check: check
• GitHub Check: fmt
• GitHub Check: examples
• GitHub Check: test
• GitHub Check: clippy
• GitHub Check: test
• GitHub Check: examples
• GitHub Check: check
• GitHub Check: clippy
• GitHub Check: fmt
• GitHub Check: hooks

🧰 Additional context used

🪛 markdownlint-cli2 (0.22.1)

.github/PULL_REQUEST_TEMPLATE.md

[warning] 1-1: First line in a file should be a top-level heading

(MD041, first-line-heading, first-line-h1)

🔇 Additional comments (2)

.github/PULL_REQUEST_TEMPLATE.md (2)

1-4: LGTM!

---

6-10: LGTM!

[coderabbitai]

🧹 Nitpick | 🔵 Trivial | 💤 Low value

Markdownlint warning is a false positive for PR templates.

The markdownlint hint flagging the lack of a top-level (H1) heading is expected and safe to suppress. GitHub PR templates conventionally use H2 (##) headings because the PR title serves as the implicit H1. Adding an H1 to the template would create a duplicate top-level heading in the rendered PR body.

If you want to suppress this warning, add a .markdownlint.json or .markdownlintrc configuration:

{
  "MD041": false
}

Or scope the suppression to this file specifically via inline comment or glob pattern.

🧰 Tools

🪛 markdownlint-cli2 (0.22.1)

[warning] 1-1: First line in a file should be a top-level heading

(MD041, first-line-heading, first-line-h1)

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @.github/PULL_REQUEST_TEMPLATE.md at line 1, The markdownlint warning MD041
for the template heading is a false positive; suppress it either globally by
adding a config that sets "MD041": false in your markdownlint config (e.g.,
.markdownlint.json) or locally by adding an inline file-level disable comment at
the top of the template (e.g., add <!-- markdownlint-disable MD041 --> before
the existing "## Motivation" heading) so the lint tool ignores the missing H1
for this PR template.