Skip to content

Commit

Permalink
Add PULL_REQUEST_TEMPLATEs
Browse files Browse the repository at this point in the history
Problem

We want to make it as easy as possible for our contributors to do the
right thing.

Solution

Use Github's PR templates[1] to help them do this.

Result

Pull requests are more likely to be formatted correctly.

[1] https://help.github.com/articles/creating-a-pull-request-template-for-your-repository/

RB_ID=808946
  • Loading branch information
kevinoliver authored and jenkins committed Mar 10, 2016
1 parent 190cdc9 commit 22aa940
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 4 deletions.
15 changes: 15 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
Problem

Explain the context and why you're making that change. What is the
problem you're trying to solve? In some cases there is not a problem
and this can be thought of being the motivation for your change.

Solution

Describe the modifications you've done.

Result

What will change as a result of your pull request? Note that sometimes
this section is unnecessary because it is self-explanatory based on
the solution.
12 changes: 8 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,22 +49,26 @@ Comments should be formatted to a width no greater than 80 columns.
Files should be exempt of trailing spaces.

We adhere to a specific format for commit messages. Please write your commit
messages along these guidelines:
messages along these guidelines. Please keep the line width no greater than
80 columns (You can use `fmt -n -p -w 80` to accomplish this).

One line description of your change (less than 72 characters)

Problem

Explain here the context, and why you're making that change.
What is the problem you're trying to solve?
Explain the context and why you're making that change. What is the
problem you're trying to solve? In some cases there is not a problem
and this can be thought of being the motivation for your change.

Solution

Describe the modifications you've done.

Result

After your change, what will change?
What will change as a result of your pull request? Note that sometimes
this section is unnecessary because it is self-explanatory based on
the solution.

## Code Review

Expand Down

0 comments on commit 22aa940

Please sign in to comment.