Skip to content

Commit

Permalink
docs(user): Add commit message guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
hfaran committed Jan 11, 2015
1 parent 285f7b4 commit 742fdd1
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,26 @@ sudo python setup.py install
* [Issue Tracker](https://github.com/hfaran/piazza-api/issues)
* [Source Code](github.com/hfaran/piazza-api)

### Commit Message Guidelines

Commit messages should be written with the following style: `%{type}(%{scope}): %{description}`.

* Valid `type`s are
- `feat`
- `fix`
- `docs`
- `style`
- `refactor`
- `perf`
- `test`
- `revert`

* Valid `scope`s are
- `dev` (if the change is irrevelant to the user or otherwise has no impact on the top-level API and only to developers)
- `user` (if this commit is a change that affects the top-level user-facing interface)

* `description` is the actual commit message


## License

Expand Down

0 comments on commit 742fdd1

Please sign in to comment.