From ae460a807c38d043b3692037f040a83e61054b60 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Sim=C3=B3n=20Fishman?= <simonpfish@gmail.com>
Date: Fri, 22 Sep 2023 08:52:02 -0700
Subject: [PATCH] Add pull request template (#731)

---
 .github/pull_request_template.md | 36 ++++++++++++++++++++++++++++++++
 1 file changed, 36 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..ae9d7c0
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,36 @@
+## Summary
+
+Briefly describe the changes and the goal of this PR. Make sure the PR title summarizes the changes effectively.
+
+## Changes
+
+List the major and minor changes.
+
+- Major Changes
+  - ...
+- Minor Changes
+  - ...
+
+## Motivation
+
+Why are these changes necessary? How do they improve the cookbook?
+
+## Self Review Checklist
+
+- [ ] Is the writing easily skimmable?
+  - Sections have informative titles.
+  - Key takeaways are upfront.
+  - Short paragraphs and topic sentences are used.
+- [ ] Is the writing quality high?
+  - Sentences are simple and unambiguous.
+  - Demonstrative pronouns are avoided or clearly referenced.
+  - No left-branching sentences.
+- [ ] Is the content universally helpful?
+  - Terminology is specific and avoids jargon.
+  - Provides solutions to common problems.
+  - Code examples are general and exportable.
+- [ ] Is the content consistent?
+  - Styling and formatting align with existing documentation.
+  - Consistent use of punctuation and case.
+
+**Note:** For additional guidelines on writing good documentation, check out [What Makes Documentation Good](https://cookbook.openai.com/what_makes_documentation_good).