From 519de4341774cc8647ac12e17b91aa41c5522214 Mon Sep 17 00:00:00 2001 From: Emily Shen Date: Thu, 8 Aug 2024 17:12:14 -0400 Subject: [PATCH] docs: Add pull request template --- .github/pull_request_template.md | 38 ++++++++++++++++++++++++++++++++ 1 file changed, 38 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..d2c7697 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,38 @@ +# Description + +[comment]: # 'Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.' + +Fixes # (issue) + +## Type of change + +[comment]: # 'Please delete options that are not relevant.' + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] This change requires a documentation update + +## Screenshots + +[comment]: # 'Please include screenshots of your changes if relevant.' + +| Before | After | +| :-----------------: | :----------------: | +| "screenshot before" | "screenshot after" | + +# How Has This Been Tested? + +- [ ] Cypress integration +- [ ] Cypress component tests +- [ ] Jest unit tests + +# Checklist: + +- [ ] I have performed a self-review of my own code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation +- [ ] My changes generate no new warnings +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] New and existing unit tests pass locally with my changes +- [ ] Any dependent changes have been merged and published in downstream modules