Skip to content

Commit

Permalink
add default pull request template
Browse files Browse the repository at this point in the history
Signed-off-by: Jose Borreguero <[email protected]>
  • Loading branch information
jmborr committed Apr 27, 2024
1 parent ea8efca commit 125bc2d
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 8 deletions.
8 changes: 0 additions & 8 deletions .github/PULL_REQUEST_TEMPLATE/pull_request_template.md

This file was deleted.

24 changes: 24 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# References
- EWM #
<!-- Links to related issues or pull requests -->

# Description of the changes:
<!-- description here. -->

# Manual test for the reviewer
<!-- Instructions for testing here. -->

# Check list for the reviewer
- [ ] I have verified the proposed changes
- [ ] Author included tests for the proposed changes
- [ ] best software practices
+ [ ] clearly named variables (better to be verbose in variable names)
+ [ ] code comments explaining the intent of code blocks
+ [ ] new functions and classes detailed docstrings, parameters documented
- [ ] All tests are passing
- [ ] Documentation is up to date

# Check list for the author
- [ ] I have added tests for my changes
- [ ] I have updated the documentation accordingly
- [ ] I included a link to IBM EWM Story or Defect

0 comments on commit 125bc2d

Please sign in to comment.