From 80c2a5177f156d43cf4627e797341aea0858e9f6 Mon Sep 17 00:00:00 2001 From: Morgan Bauer Date: Tue, 17 Jul 2018 09:33:38 -0700 Subject: [PATCH] PR Template (#2206) * PR Template * update with ideas from upstream k/k * add documentation requirement to CONTRIBUTING --- .github/PR_TEMPLATE.md | 29 +++++++++++++++++++++++++++++ CONTRIBUTING.md | 2 ++ 2 files changed, 31 insertions(+) create mode 100644 .github/PR_TEMPLATE.md diff --git a/.github/PR_TEMPLATE.md b/.github/PR_TEMPLATE.md new file mode 100644 index 00000000000..f4263e9e1fe --- /dev/null +++ b/.github/PR_TEMPLATE.md @@ -0,0 +1,29 @@ + + +This PR is a + - [ ] Feature Implementation + - [ ] Bug Fix + - [ ] Documentation + +**What this PR does / why we need it**: + +**Which issue(s) this PR fixes** + +Fixes # + +Please leave this checklist in the PR comment so that maintainers can ensure a good PR. + +Merge Checklist: + - [ ] New feature + - [ ] Tests + - [ ] Documentation + - [ ] SVCat CLI flag + - [ ] Server Flag for config + - [ ] Chart changes + - [ ] removing a flag by marking deprecated and hiding to avoid + breaking the chart release and existing clients who provide a + flag that will get an error when they try to update diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 64798504401..208148a93d4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,6 +16,8 @@ not just a partial solution. include tests that demonstrates the issue w/o your fix. New features should include as many testcases, within reason, to cover any variants of use of the feature. +- All PRs must have appropriate documentation. New features should be + described, and an example of use provided. - PR authors will need to have CLA on-file with the Linux Foundation before the PR will be merged. See Kubernete's [contributing guidelines](https://github.com/kubernetes/kubernetes/blob/master/CONTRIBUTING.md) for more information.