diff --git a/README.md b/README.md index 4b6e65d..692a682 100644 --- a/README.md +++ b/README.md @@ -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