From 29fdf2fdab49758d095adf33f15ed932e75d6fa8 Mon Sep 17 00:00:00 2001 From: Tejal Desai Date: Mon, 16 Sep 2019 15:12:29 -0700 Subject: [PATCH] add github pull request template --- .github/pull_request_template.md | 68 ++++++++++++++++++++++++++++++++ DEVELOPMENT.md | 1 + 2 files changed, 69 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000000..a42a8c1ee89 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,68 @@ + + + +Relates to _in case of new feature, this should point to issue/(s) which describes the feature_ + +Fixes _in case of a bug fix, this should point to a bug and any other related issue(s)_ + +Should merge before : _list any dependent PRs_ + +# Description + + + +# Output Changes +Write n/a if not output or log lines added + +## Before +Paste skaffold output before your change + +## After +Paste skaffold output after your change + +## Next PRs. + +In this section describe a list of follow up PRs if the current PR is a part of big feature change. + +See example #2811 + +Write n/a if not applicable. + + +# 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) +- [ ] Mentions any output changes. + +_See [the contribution guide](../CONTRIBUTING.md) for more details._ + +Double check this list of stuff that's easy to miss: + +- If you are adding [a example to the `examples` dir](../examples), please copy them to [`integration/examples`](../integration/examples) +- Every new example added in [`integration/examples`](../integration/examples) dir should be tested in [integration test](../integration) + +## Reviewer Notes + +- [ ] The code flow looks good. +- [ ] Unit test added. +- [ ] User facing document changes look good. + + +# Release Notes + +Describe any user facing 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." + +``` \ No newline at end of file diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index 70e1e134836..50efcef1b99 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -238,6 +238,7 @@ When you have changes you would like to propose to skaffold, you will need to: 1. Ensure the commit message(s) describe what issue you are fixing and how you are fixing it (include references to [issue numbers](https://help.github.com/articles/closing-issues-using-keywords/) if appropriate) +1. Add unit tests. Unit test coverage should increase or stay the same with every PR. 1. [Create a pull request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) ### Reviews