mirror of
https://github.com/funkypenguin/geek-cookbook/
synced 2025-12-12 17:26:19 +00:00
Update default PR template
Signed-off-by: David Young <davidy@funkypenguin.co.nz>
This commit is contained in:
20
.github/pull_request_template.md
vendored
20
.github/pull_request_template.md
vendored
@@ -1,4 +1,4 @@
|
||||
<!--- Provide a general summary of your changes in the Title above -->
|
||||
<!-- Provide a general summary of your changes in the Title above ^^^ -->
|
||||
|
||||
## Description
|
||||
<!--- Describe your changes in detail -->
|
||||
@@ -18,10 +18,18 @@
|
||||
- [ ] New feature (non-breaking change which adds functionality)
|
||||
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
|
||||
|
||||
## Checklist:
|
||||
## Checklist
|
||||
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
|
||||
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
|
||||
- [ ] My code follows the code style of this project.
|
||||
- [ ] My change requires a change to the documentation.
|
||||
- [ ] I have updated the documentation accordingly.
|
||||
- [ ] I have read the **CONTRIBUTING** document.
|
||||
|
||||
- [ ] I have read the [contribution guide](https://geek-cookbook.funkypenguin.co.nz/community/contribute/#contributing-recipes)
|
||||
- [ ] The format of my changes matches that of other recipes (*ideally it was copied from [template](/manuscript/recipes/template.md)*)
|
||||
- [ ] I've added at least one footnote to my recipe (*Chef's Notes*)
|
||||
<!--
|
||||
delete these next checks if not adding a new recipe
|
||||
-->
|
||||
- [ ] I've updated the navigation in `mkdocs.yaml` in alphabetical order
|
||||
- [ ] I've updated `CHANGELOG.md` in reverse chronological order order
|
||||
- [ ] I'm using the [oldest-possible version](https://docs.docker.com/compose/compose-file/compose-versioning/#version-3) of Docker-compose syntax for the feature my recipe needs
|
||||
- [ ] If traefik integration is required, I've included both v1 and v2 labels (*see [template](/manuscript/recipes/template.md)*)
|
||||
- [ ] If a recipe-specific overlay network is required, I've used a unique subnet and recorded it in [networks.md](manuscript/reference/networks.md)
|
||||
Reference in New Issue
Block a user