Skip to content

Commit

Permalink
#2998: contributing.md, adjust styleguide
Browse files Browse the repository at this point in the history
  • Loading branch information
jeff1evesque committed Jul 19, 2017
1 parent bbd57f2 commit 4faf03f
Showing 1 changed file with 19 additions and 8 deletions.
27 changes: 19 additions & 8 deletions contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ index.php, include 'header.php'
More specifically, the following rules of a descriptive issue title *must* be
followed:

- an issue title should *never* be over 55 characters
- an issue title should *never* be over 50 characters
- an issue title should *never* contain possessive tones
- filename reference(s) in the issue title, should *always* be wrapped by
single quotes
Expand Down Expand Up @@ -72,7 +72,7 @@ git checkout -b [bug|feature|remove]-[issue number] master

## Committing Code

When creating a *commit*, be sure to include an issue number, the filename
When creating a *commit*, be sure to include an issue number, the filename (preferred)
modified, and a short message.

The following git commit message, is an acceptable syntax:
Expand All @@ -81,11 +81,17 @@ The following git commit message, is an acceptable syntax:

The message should *always* be prefixed with an issue number that the commit
corresponds to. When all components are factored in, the commit message should
*never* be more than 65 characters long, *never* be in a possessive tone, and
*never* be more than 50 characters long, *never* be in a possessive tone, and
any references to a file, or method *should* be wrapped by a single quote.

**Note:** commits should be granular, such that, every commit corresponds to a
small change within *one* file.
small change within *one* file. In some cases, when a commit spans multiple
files, when changes are very similar, or when merging one branch, into the
current branch, the filename can be omitted:

```text
#2844: conform boolean values to python syntax
```

## Creating Pull Request

Expand All @@ -101,14 +107,19 @@ More specifically, the following rules *must* be followed:

- a pull request title should *always* begin with the issue number, and the
file modified
- a pull request title should *never* be over 55 characters (including the
- a pull request title should *never* be over 50 characters (including the
*issue number*)
- a pull request title should *never* contain possessive tones
- filename reference(s) in the pull request title, should *always* be wrapped
by single quotes

**Note:** in some cases, the filename is longer than usual, and can be omitted
from the pull request title.
**Note:** in some cases, the filename is longer than usual, or the corresponding
issue spans multiple files. In these cases, the filename can be omitted from
the pull request title:

```text
Add ability to create randomized sub-datasets
```

### Pull Request: Body

Expand All @@ -126,4 +137,4 @@ Always include one of the following [*keywords*](https://help.github.com/article
- Resolved

For example, including `Resolves #230` in the *pull request* body, will
automatically close issue `#230` when the *pull request* is merged.
automatically close issue `#230` when the *pull request* is merged.

0 comments on commit 4faf03f

Please sign in to comment.