diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..cd79bab --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,36 @@ +# Description + +Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context, such as the description of the bug you're trying to fix. + +Fixes # (issue) + +## Type of change + +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 + +## Shells this fix should effect: +- [ ] bash +- [ ] zsh +- [ ] fish + +## Shells this fix has been tested in: +- [ ] bash +- [ ] zsh +- [ ] fish + +**Test Configuration**: +* OS: + +# Checklist: + +- [ ] My code follows the style guidelines of this project +- [ ] 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 + +@cjappl @wxfr