From 96d1d6019ca4a13ede46e9118a9c14ac9e340e0b Mon Sep 17 00:00:00 2001
From: M Zidan Fatonie <mzidanfatonie@gmail.com>
Date: Fri, 14 Aug 2026 22:41:55 +0800
Subject: [PATCH] docs: add pull request template

Add a .github/PULL_REQUEST_TEMPLATE.md modeled on leanSpec's template to
make PR descriptions more consistent and remind contributors to run
checks and consider tests before opening a PR.

Closes #52
---
 .github/PULL_REQUEST_TEMPLATE.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 .github/PULL_REQUEST_TEMPLATE.md

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..08b9e3f
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,25 @@
+## 🗒️ Description / Motivation
+<!-- Brief description of the changes introduced by this PR and why they are needed. -->
+
+## What Changed
+<!-- List the files touched and a brief summary of each change. -->
+
+## Correctness / Behavior Guarantees
+<!-- Any invariants preserved or broken by this change. Default is N/A. -->
+
+## Tests Added / Run
+<!-- Describe the tests added or run to validate the changes. -->
+
+## 🔗 Related Issues or PRs
+<!-- Reference any related issues using the GitHub issue number (e.g., Closes #123). Default is N/A. -->
+
+## ✅ Checklist
+<!-- Please check off all required items. For those that don't apply remove them accordingly. -->
+
+- [ ] Ran local quality checks to avoid unnecessary CI fails:
+    ```console
+    cargo fmt -- --check
+    cargo clippy --workspace --lib --examples --tests --benches --all-features -- -D warnings
+    cargo test
+    ```
+- [ ] Considered adding appropriate tests for the changes.