Skip to content

Commit

Permalink
replace contrib guide section about PR formatting with a change to th…
Browse files Browse the repository at this point in the history
…e PR template
  • Loading branch information
iliapolo committed Mar 4, 2020
1 parent 0bb21c0 commit 1521da0
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 41 deletions.
27 changes: 26 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,35 @@
## Description

<!--
The description should describe _motivation_. Think about your code reviewers and what information they need in order to understand what you did. If it's a big commit (hopefully not), try to provide some good entry points so it will be easier to follow.
If not obvious (i.e. from unit tests), describe how you verified that your change works.
-->

## Commit Message
<!--Simply copy paste from the PR title and replace the necessary parts-->
{*replace-with-pr-title*} (#{*replace-with-pr-number*})

<!--Use this to give a more detailed message that describes the change-->
{replace-with-extended-commit-message}

<!--For every issue your PR resolves, add `fixes #<issue>` or `closes #<issue>`-->

<!--Shout out to collaborators.-->

<!--If your PR includes breaking changes, uncomment and fill in the following (notice how multiple breaking changes should be formatted):-->
<!--
BREAKING CHANGE: Description of what broke and how to achieve this behavior now<br>
\* **module-name:** Another breaking change<br>
\* **module-name:** Yet another breaking change
-->

## <!--DO NOT REMOVE (used as the commit message terminator)-->

----

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

<!--
<!--
Please read the contribution guidelines and follow the pull-request checklist:
https://github.com/aws/aws-cdk/blob/master/CONTRIBUTING.md
-->
42 changes: 2 additions & 40 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,49 +164,11 @@ Examples:
### Step 4: Pull Request

* Push to a GitHub fork or to a branch (naming convention: `<user>/<feature-bug-name>`)
* Submit a Pull Request on GitHub and assign the PR for a review to the "awslabs/aws-cdk" team. The title and description will be used to format the commit message when its merged to master. This in turn, will translate to CHANGELOG entries. It is therefore important we be consistent and informative.

##### PR Title

The title must adhere to [conventionalcommits](https://www.conventionalcommits.org).
It should shortly describe the **what**, not the **how**, Think about the user seeing this in the CHANGELOG.

- Must begin with `feat(module): title`, `fix(module): title`, `refactor(module): title` or `chore(module): title`.
- Lowercase.
- No period at the end.

##### PR Description

The description should describe _motivation_. Think about your code reviewers and what information they need in order to understand what you did.
If it's a big commit (hopefully not), try to provide some good entry points so it will be easier to follow.

- Should include the following section:

```text
## Commit Message
{insert-pr-title} (#{insert-pr-number})
{insert-any-additional-text}
## End Commit Message
```
- If your change introduces a breaking change, describe it as the last paragraph in the `Commit Message` section like so:
```
BREAKING CHANGE: Description of what broke and how to achieve this behavior now
* **module-name:** Another breaking change
* **module-name:** Yet another breaking change
```
> Notice how multiple breaking changes should be formatted.
- Should indicate which issues are fixed: `fixes #<issue>` or `closes #<issue>`.
- Shout out to collaborators.
- If not obvious (i.e. from unit tests), describe how you verified that your change works. This should be separate from the `Commit Message` section, as its only intended for the review process.
* Submit a Pull Request on GitHub and assign the PR for a review to the "awslabs/aws-cdk" team. The title and description will be used to format the commit message when its merged to master. This in turn, will translate to CHANGELOG entries. It is therefore important we be consistent and informative. Simply follow the PR template carefully.

Here is an example PR you should use as a reference: https://github.com/aws/aws-cdk/pull/6553.

> **We validate this format automatically as part of our PR checks, so don't worry, you can't get this wrong :)**
> **We validate the PR format automatically as part of our PR checks, so don't worry, you can't get this wrong :)**
* Please follow the PR checklist written below. We trust our contributors to self-check, and this helps that process!
* Discuss review comments and iterate until you get at least one “Approve”. When iterating, push new commits to the
Expand Down

0 comments on commit 1521da0

Please sign in to comment.