diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b5995ae5..4a72292b 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -10,21 +10,24 @@ ## How Has This Been Tested? - - - + - [ ] I have tested the markdown appearance with Docker (Refer to the [local development instructions](https://github.com/openfaas/docs#local-development)) + + ## Types of changes - -- [ ] 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 change) + + + +- [ ] New Content +- [ ] Content Correction +- [ ] Content Improvement +- [ ] Non-content (config/templates/mkdocs/CSS) ## 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 tested any new instructions +- [ ] I have included copyrighted materials from third parties. +- [ ] I have permission to use copyrighted materials from third parties. - [ ] I've read the [CONTRIBUTION](https://github.com/openfaas/faas/blob/master/CONTRIBUTING.md) guide - [ ] I have signed-off my commits with `git commit -s` diff --git a/README.md b/README.md index a8b47926..874e100b 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ This is the source repository for the OpenFaaS documentation site. -For local development: +## Local development: ```shell # docker run --rm -it -p 8000:8000 -v `pwd`:/docs squidfunk/mkdocs-material