Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add pull request checklist #1228

Merged
merged 2 commits into from
Nov 21, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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 in 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): <title>` 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?__: 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`

----

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license.