Skip to content

Commit

Permalink
Update contributing instruction for PR titles (cadence-workflow#1393)
Browse files Browse the repository at this point in the history
* Update contributing instruction for PR titles

* Adding examples of PR titles and fix some typos
  • Loading branch information
longquanzheng authored Jan 16, 2019
1 parent 0fda8e2 commit 2f4092c
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,22 @@ all source files. To verify that all files contain the header execute:
make copyright
```

## Commit Messages
## Commit Messages And Titles of Pull Requests

Overcommit adds some requirements to your commit messages. At Uber, we follow the
[Chris Beams](http://chris.beams.io/posts/git-commit/) guide to writing git
commit messages. Read it, follow it, learn it, love it.

All commit messages are from the titles of your pull requests. So make sure follow the rules when titling them.
Please don't use very generic titles like "bug fixes".

All PR titles should start with UPPER case.

Examples:

- [Make sync activity retry multiple times before fetch history from remote](https://github.com/uber/cadence/pull/1379)
- [Enable archival config per domain](https://github.com/uber/cadence/pull/1351)

## Issues to start with

Take a look at the list of issues labeled
Expand Down

0 comments on commit 2f4092c

Please sign in to comment.