Create PULL_REQUEST_TEMPLATE.md

mehrankmlf · Sep 15, 2023 · 8962501 · 8962501
1 parent e5dcf94
commit 8962501
Showing 1 changed file with 32 additions and 0 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,32 @@
+### 🛠 Changes being made
+
+Here give examples of the changes you've made in this pull request. Include an itemized list if you can. It'll help the reviewer
+
+
+### ✨ What's the context?
+
+What's the context for the changes? Are there any
+
+
+### 🧠 Rationale behind the change
+
+Why did you choose to make these changes? Were there any trade-offs you had to consider? 
+
+
+### 🧪 Test plan
+
+How do you know the changes are safe to ship to production?
+
+
+### 📸 Screenshots (optional)
+
+If you made UI changes, what are the before an afters?
+
+
+### 🏎 Quality check
+
+- [ ] Are your changes following SOLID principles?
+
+- [ ] Are there any erroneous console logs, debuggers or leftover code in your changes?
+
+- [ ] Walk away, take a break, re-read what you filled out above does it make sense if you were coming in cold? What extra context could you provide?