From 5bf1acc403d3f08cfd8ee8928c5ce11d1137e861 Mon Sep 17 00:00:00 2001 From: David Young Date: Wed, 13 Jan 2021 09:44:26 +1300 Subject: [PATCH] Update default PR template Signed-off-by: David Young --- .github/pull_request_template.md | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index ee64c1a..87d5d66 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,4 +1,4 @@ - + ## Description @@ -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 -- [ ] 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*) + +- [ ] 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) \ No newline at end of file