From 23698f444711332e513a34e87bab843780207c36 Mon Sep 17 00:00:00 2001 From: James McHugh Date: Thu, 22 Aug 2024 13:46:52 -0400 Subject: [PATCH] Create pull_request_template.md --- pull_request_template.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 pull_request_template.md diff --git a/pull_request_template.md b/pull_request_template.md new file mode 100644 index 0000000..8c547cd --- /dev/null +++ b/pull_request_template.md @@ -0,0 +1,35 @@ +## Description of Changes +[Provide a brief description of the changes introduced by this pull request.] + +## What are the relevant tickets (if any) + +This PR is related to issue # , and will be closed upon successful merge of this PR request. + +## Screenshots (if applicable) +[Include screenshots or animated GIFs that help visualize the changes, if applicable.] + +## Testing +[Describe the testing process that has been done, including any relevant test cases or +scenarios covered. If applicable, provide steps for reviewers to manually test the changes.] + +## Checklist +- [ ] The code follows the project's coding standards. +- [ ] Unit tests have been added or updated to cover the changes. +- [ ] Documentation has been updated to reflect the changes (if applicable). +- [ ] The code compiles without errors. +- [ ] The changes have been tested locally and pass all relevant tests. +- [ ] All new and existing tests pass. +- [ ] The pull request has been reviewed by at least one other contributor. + +## Reviewer Instructions +[Provide any specific instructions or information that would help the reviewer understand the +context or nuances of the changes.] + +## Deployment Notes +[Include any notes or instructions related to the deployment of this pull request, if +applicable.] + +## Additional Information +[Add any additional information that may be relevant to the review or understanding of the +changes. This could include performance considerations, dependencies, or other relevant +details.]