Skip to content

Commit

Permalink
chore: update pull request checklist (aws#3987)
Browse files Browse the repository at this point in the history
external contributors are unable to check the boxes in the checklist, so reformat it as a normal bullet list and also make it a little friendlier.
  • Loading branch information
Elad Ben-Israel authored Sep 9, 2019
1 parent b01f62d commit 743764a
Showing 1 changed file with 19 additions and 19 deletions.
38 changes: 19 additions & 19 deletions .mergify.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,27 +29,27 @@ pull_request_rules:
add: [ automerge-enabled ]
comment:
message: |
### Pull Request Checklist
Thanks so much for taking the time to contribute to the AWS CDK ❤️
* [ ] Testing
- Unit test added (prefer to add a new test rather than modify existing tests)
- CLI change? Re-run/add [CLI integration tests](https://github.com/aws/aws-cdk/blob/master/CONTRIBUTING.md#running-cli-integration-tests)
* [ ] Documentation
- **Inline docs**: make sure all public APIs are documented (copy & paste from official AWS docs)
- **README**: update module README
- **Design**: for significant features, follow the [design process](https://github.com/aws/aws-cdk/blob/master/CONTRIBUTING.md#step-2-design-optional)
* [ ] Title uses the format `type(scope): text`
- __Type__: `fix`, `feat`, `refactor` go into CHANGELOG, `chore` is hidden
- __Scope__: name of the module without the `aws-` or `cdk-` prefix or postfix (e.g. `s3` instead of `aws-s3-deployment`)
- __Style__: use all **lower-case**, **do not** end with a period
* [ ] Description
We will shortly assign someone to review this pull request and help get it
merged. In the meantime, please **take a minute to make sure you follow this
checklist**:
* **PR title `type(scope): text`**
* __type__: `fix`, `feat`, `refactor` go into CHANGELOG, `chore` is hidden
- __scope__: name of module without `aws-` or `cdk-` prefix or postfix (e.g. `s3` instead of `aws-s3-deployment`)
- __text__: use all **lower-case**, **do not** end with a period, do not include issue refs
* **PR Description**
- __Rationale__: describe rationale of change and approach taken
- __Issues__: Indicate issues fixed via: `fixes #xxx` or `closes #xxx`
- __Issues__: indicate issues fixed via: `fixes #xxx` or `closes #xxx`
- __Breaking?__: last paragraph: `BREAKING CHANGE: <describe what changed + link for details>`
* [ ] Sensitive Modules (requires 2 PR approvers)
- IAM document library (in @aws-cdk/aws-iam)
- EC2 security groups and ACLs (in @aws-cdk/aws-ec2)
- Grant APIs (if not based on official documentation with a reference)
* **Testing**
- Unit test added. Prefer to add a new test rather than modify existing tests
- **CLI or init templates change**? Re-run/add [CLI integration tests](https://github.com/aws/aws-cdk/blob/master/CONTRIBUTING.md#running-cli-integration-tests)
* **Documentation**
- **README**: update module README to describe new features
- **API docs**: public APIs must be documented. Copy from official AWS docs when possible
- **Design**: for significant features, follow [design process](https://github.com/aws/aws-cdk/blob/master/CONTRIBUTING.md#step-2-design-optional)
conditions:
- author!=dependabot[bot]
- author!=dependabot-preview[bot]
Expand All @@ -58,7 +58,7 @@ pull_request_rules:
- name: comment on CI fail
actions:
comment:
message: Codebuild (Continuous Integration) build failed for current commits. Please check log and resolve before PR is merged.
message: Continuous integration build failed
conditions:
- author!=dependabot[bot]
- author!=dependabot-preview[bot]
Expand Down

0 comments on commit 743764a

Please sign in to comment.