From 10c8bb0b9ab7fb5c42e437a3505d5785ac2ed33e Mon Sep 17 00:00:00 2001
From: Li Yin <li.yin.gravity@gmail.com>
Date: Sun, 17 Nov 2024 12:21:10 -0800
Subject: [PATCH] add the pull request template

---
 .github/PULL_REQUEST_TEMPLATE.md         | 38 ++++++++++++++++++++++++
 docs/source/contributor/contribution.rst |  4 +++
 2 files changed, 42 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 00000000..11b27377
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,38 @@
+## What does this PR do?
+
+<!--
+Please include a summary of the change and which issue is fixed.
+Please also include relevant motivation and context.
+List any dependencies that are required for this change.
+
+If we didn't discuss your PR in Github issues there's a high chance it will not be merged.
+
+The following links the related issue to the PR (https://docs.github.com/en/free-pro-team@latest/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword)
+-->
+
+Fixes #\<issue_number>
+
+<!-- Does your PR introduce any breaking changes? If yes, please list them. -->
+
+<details>
+  <summary><b>Before submitting</b></summary>
+
+- Was this **discussed/agreed** via a GitHub issue? (not for typos and docs)
+- [ ] Did you read the [contributor guideline](https://adalflow.sylph.ai/contributor/index.html)?
+- [ ] Did you make sure your **PR does only one thing**, instead of bundling different changes together?
+- Did you make sure to **update the documentation** with your changes? (if necessary)
+- Did you write any **new necessary tests**? (not for typos and docs)
+- [ ] Did you verify new and **existing tests pass** locally with your changes?
+- Did you list all the **breaking changes** introduced by this pull request?
+
+
+</details>
+
+
+<!--
+
+Did you have fun?
+
+Make sure you had fun coding 🙃
+
+-->
diff --git a/docs/source/contributor/contribution.rst b/docs/source/contributor/contribution.rst
index 83509b8a..9343a304 100644
--- a/docs/source/contributor/contribution.rst
+++ b/docs/source/contributor/contribution.rst
@@ -261,6 +261,10 @@ So far, we are still working on the code in the `/benchmarks` directory. We will
 Part 4: PR & Review Process
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
+**Before submitting a PR**
+
+Ensure you add a checklist.
+
 You are always welcomed to contribute even if you've never participated in open source project before.
 Here is the basic contribution process: