Skip to content

Commit

Permalink
Create pull_request_template.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mdahlhausen committed Sep 12, 2023
1 parent 37c5f34 commit 9812d2b
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
Pull request overview
---------------------

<!--- DESCRIBE PURPOSE OF THIS PULL REQUEST -->

- Fixes #ISSUENUMBERHERE (IF THIS IS A DEFECT)

### Pull Request Author

<!--- Add to this list or remove from it as applicable. This is a simple templated set of guidelines. -->

- [ ] Method changes or additions
- [ ] Data changes or additions
- [ ] Added tests for added methods
- [ ] If methods have been deprecated, update rest of code to use the new methods
- [ ] Documented new methods using [yard syntax](https://rubydoc.info/gems/yard/file/docs/GettingStarted.md)
- [ ] Resolved yard documentation errors for new code (ran `bundle exec rake doc`)
- [ ] Resolved rubocop syntax errors for new code (ran `bundle exec rake rubocop`)
- [ ] All new and existing tests passes
- [ ] If the code adds new `require` statements, ensure these are in core ruby or add to the gemspec

### Review Checklist

This will not be exhaustively relevant to every PR.
- [ ] Perform a code review on GitHub
- [ ] All related changes have been implemented: method additions, changes, tests
- [ ] Check rubocop errors
- [ ] Check yard doc errors
- [ ] If fixing a defect, verify by running develop branch and reproducing defect, then running PR and reproducing fix
- [ ] If a new feature, test the new feature and try creative ways to break it
- [ ] CI status: all green or justified

0 comments on commit 9812d2b

Please sign in to comment.