From 961b5476f1421820bf731115f57e17e9c6825849 Mon Sep 17 00:00:00 2001 From: Elad Ben-Israel Date: Wed, 21 Nov 2018 13:36:56 +0200 Subject: [PATCH 1/2] chore: add pull request checklist Fixes awslabs/cdk-ops#171 --- .github/PULL_REQUEST_TEMPLATE.md | 36 ++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index c9aaf9b71608b..b8e3bb2356b98 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1 +1,37 @@ + +---- + +### Pull Request Checklist + +Please check all boxes (including N/A items) + +#### Testing + +- [ ] Unit test and/or integration test added +- [ ] __Toolkit change?:__ [integration +tests](https://github.com/awslabs/aws-cdk/blob/master/packages/aws-cdk/integ-tests/test.sh) +manually executed (paste output to the PR description) +- [ ] __Init template change?:__ coordinated update of integration tests +(currently maintained a private repo). + +#### Documentation + +- [ ] __README__: README and/or documentation topic updated +- [ ] __jsdocs__: All public APIs documented + +### Title and description + +- [ ] __Change type__: Title is prefixed with change type: + * `fix(module): ` bug fix (_patch_) + * `feat(module): <title>` feature/capability (_minor_) + * `chore(module): <title> ` won't appear in changelog + * `build(module): <title>` won't appear in changelog +- [ ] __Title format__: Title uses lower case and doesn't end with a period +- [ ] __Breaking change?__: Description ends with: `BREAKING CHANGE: <one +line which describes exactly what changed and how to achieve similar +behavior after the change>` +- [ ] __References__: Indicate issues fixed via: `Fixes #xxx` or `Closes #xxx` + +---- + By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license. From 291d6d76ea7f75a99125fbd33cadb6d2aefa68ba Mon Sep 17 00:00:00 2001 From: Elad Ben-Israel <benisrae@amazon.com> Date: Wed, 21 Nov 2018 14:32:23 +0200 Subject: [PATCH 2/2] CR updates --- .github/PULL_REQUEST_TEMPLATE.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b8e3bb2356b98..6250e88d22536 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -12,7 +12,7 @@ Please check all boxes (including N/A items) tests](https://github.com/awslabs/aws-cdk/blob/master/packages/aws-cdk/integ-tests/test.sh) manually executed (paste output to the PR description) - [ ] __Init template change?:__ coordinated update of integration tests -(currently maintained a private repo). +(currently maintained in a private repo). #### Documentation @@ -27,9 +27,9 @@ manually executed (paste output to the PR description) * `chore(module): <title> ` won't appear in changelog * `build(module): <title>` won't appear in changelog - [ ] __Title format__: Title uses lower case and doesn't end with a period -- [ ] __Breaking change?__: Description ends with: `BREAKING CHANGE: <one -line which describes exactly what changed and how to achieve similar -behavior after the change>` +- [ ] __Breaking change?__: Last paragraph of description is: `BREAKING + CHANGE: <describe exactly what changed and how to achieve similar behavior + + link to documentation/gist/issue if more details are required>` - [ ] __References__: Indicate issues fixed via: `Fixes #xxx` or `Closes #xxx` ----