From cc42a2636a1196977e4b33e41babbed742b142b4 Mon Sep 17 00:00:00 2001 From: Francis Pelletier <32526367+f-PLT@users.noreply.github.com> Date: Thu, 16 Jan 2025 19:42:55 -0500 Subject: [PATCH] Add Pull Request Template to the Project (#674) * Fiirst draft of pull_request_template.md --- .github/pull_request_template.md | 34 ++++++++++++++++++++++++++++++++ 1 file changed, 34 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 000000000..5f6dbd990 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,34 @@ +## Summary +Brief description of what this PR does. (tl;dr). + +### List of Changes +* Modified class X +* Added model Y +* Fixed problem Z +* etc. + +### Related Issues +If the PR closes or is related to an issue, reference it here. +For example, "Closes #123", "Fixes #456" or "Relates to #741" . + +## Detailed Description +A clear and detailed description of the changes, how they solve/fix the related issues. + +Mention potential side effects or risks associated with the changes, if applicable. + +### How to Test the Changes +Instructions on how to test the changes Include references to automated and/or manual tests that were created/used to test the changes. + +### Screenshots +If applicable, add screenshots to help explain this PR (ex. Before and after for UI changes). + +## Deployment Notes +Include instructions if this PR requires specific steps for its deployment (database migrations, config changes, etc.) + +## Checklist + +- [ ] I have tested these changes appropriately. +- [ ] I have added and/or modified relevant tests. +- [ ] I updated relevant documentation or comments. +- [ ] I have verified that this PR follows the project's coding standards. +- [ ] Any dependent changes have already been merged to main.