diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..35e1abd67 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,41 @@ + + + +Fixes `#`. _in case of a bug fix, this should point to a bug and any other related issue(s)_ + +**Description** + + + +**Submitter Checklist** + +These are the criteria that every PR should meet, please check them off as you +review them: + +- [ ] Includes [unit tests](../DEVELOPMENT.md#creating-a-pr) +- [ ] Adds integration tests if needed. + +_See [the contribution guide](../CONTRIBUTING.md) for more details._ + + +**Reviewer Notes** + +- [ ] The code flow looks good. +- [ ] Unit tests and or integration tests added. + + +**Release Notes** + +Describe any changes here so maintainer can include it in the release notes, or delete this block. + +``` +Examples of user facing changes: +- Skaffold config changes like + e.g. "Add buildArgs to `Kustomize` deployer skaffold config." +- Bug fixes + e.g. "Improve skaffold init behaviour when tags are used in manifests" +- Any changes in skaffold behavior + e.g. "Artiface cachine is turned on by default." + +```