From 7fd44d0247927bc0ea7347bac31812027558c201 Mon Sep 17 00:00:00 2001 From: Sergio Chouhy Date: Wed, 18 Jun 2025 09:03:45 -0300 Subject: [PATCH 1/3] add PR template --- .github/pull_request_template.md | 40 ++++++++++++++++++++++++++++++++ 1 file changed, 40 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..2d07168 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,40 @@ +## 🎯 Purpose + +*What problem does this PR solve or what feature does it add? Mention issues related to it* + +TO COMPLETE + +## ⚙️ Approach + +*Describe the core changes introduced by this PR.* + +TO COMPLETE + +## ✅ Todo (subtasks) + +TO COMPLETE + +[ ] Subtask 1 +[ ] Subtask 2 +[ ] Subtask 3 + +## 🌱 Follow-ups + +*If there’s additional work to be done later, create and link an issue here.* + +TO COMPLETE + +## 🔗 Dependencies + +*Link PRs that must be merged before this one.* + +TO COMPLETE + +## 📋 PR Completion Checklist + +*Mark only completed items. A complete PR should have all boxes ticked.* + +[ ] Complete PR description +[ ] Implement the core functionality +[ ] Add/update tests +[ ] Add/update documentation and inline comments From a870650faf3ef4cb020cd93020a27a4d6cd85dd0 Mon Sep 17 00:00:00 2001 From: Sergio Chouhy Date: Wed, 18 Jun 2025 09:26:58 -0300 Subject: [PATCH 2/3] add how to test --- .github/pull_request_template.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 2d07168..0117799 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -18,9 +18,9 @@ TO COMPLETE [ ] Subtask 2 [ ] Subtask 3 -## 🌱 Follow-ups +## 🧪 How to Test -*If there’s additional work to be done later, create and link an issue here.* +*How to verify that this PR works as intended.* TO COMPLETE @@ -30,6 +30,13 @@ TO COMPLETE TO COMPLETE +## 🌱 Follow-ups + +*If there’s additional work to be done later, create and link an issue here.* + +TO COMPLETE + + ## 📋 PR Completion Checklist *Mark only completed items. A complete PR should have all boxes ticked.* From 352c97f25cf30e15ac2103f903ca0c56ad4bc1e5 Mon Sep 17 00:00:00 2001 From: Sergio Chouhy Date: Thu, 19 Jun 2025 09:20:44 -0300 Subject: [PATCH 3/3] update with suggestions --- .github/pull_request_template.md | 20 ++++++++------------ 1 file changed, 8 insertions(+), 12 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 0117799..c29c281 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -10,13 +10,10 @@ TO COMPLETE TO COMPLETE -## ✅ Todo (subtasks) - -TO COMPLETE - -[ ] Subtask 1 -[ ] Subtask 2 -[ ] Subtask 3 +[ ] Change ... +[ ] Add ... +[ ] Fix ... +[ ] ... ## 🧪 How to Test @@ -28,14 +25,13 @@ TO COMPLETE *Link PRs that must be merged before this one.* -TO COMPLETE +TO COMPLETE IF APPLICABLE -## 🌱 Follow-ups +## 🔜 Future Work -*If there’s additional work to be done later, create and link an issue here.* - -TO COMPLETE +*List any work intentionally left out of this PR, whether due to scope, prioritization, or pending decisions.* +TO COMPLETE IF APPLICABLE ## 📋 PR Completion Checklist