Skip to content

Commit

Permalink
Adding a pull request template
Browse files Browse the repository at this point in the history
  • Loading branch information
a-maze-d committed Dec 24, 2023
1 parent c1323d7 commit ae4303d
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
<!--- Summary of your changes in the Title above --->

## Detail description of your changes
<!--- Provide a detailed description of your changes
including motivation and background --->

## Issue ticket number and link
<!--- not requried for some simple typo corrections --->

## Type of change

Please delete options that are not relevant.

- [ ] Fixing documentation typo(s)
- [ ] 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

## Checklist before requesting a review
- [ ] I performed a self-review of my code
- [ ] I run `mix compile` and it compiles without errors or warnings
- [ ] I run `mix test` and have **100%** code coverage (and if not I explained below why)
- [ ] I run `mix credo` and no issues (that weren't there before) were found.
- [ ] I specified all functions with a type `@spec`
- [ ] I run `mix dialyzer` and no issues were found
- [ ] I added module and function documentation to all my public modules/functions
- [ ] I run `mix docs` and no issues were found
- [ ] I run through the different `livebook/`s to ensure that they all work.
- [ ] I added a new livebook (or modified an exisitng one) to explain the new functionality (only applies for major functionality)

0 comments on commit ae4303d

Please sign in to comment.