Skip to content

Commit

Permalink
docs: update README (#101)
Browse files Browse the repository at this point in the history
Signed-off-by: Andrew Rynhard <andrew@andrewrynhard.com>
  • Loading branch information
andrewrynhard authored Jan 13, 2019
1 parent 22804ff commit 2be1e1e
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@

Some of the policies included are:

- **Commits**: Enforce basic commit policies including:
- Commit message header length
- Developer Certificate of Origin
- GPG signature
- **Conventional Commits**: Enforce [conventional commits](https://www.conventionalcommits.org) for all commit messages.

## Getting Started
Expand All @@ -26,6 +30,11 @@ Create a file named `.conform.yaml` with the following contents:

```yaml:
policies:
- type: commit
spec:
headerLength: 89
dco: true
gpg: true
- type: conventionalCommit
spec:
types:
Expand Down

0 comments on commit 2be1e1e

Please sign in to comment.