From 9fa2213b3832cfa9e12b60011890eb6096e6f006 Mon Sep 17 00:00:00 2001 From: Andrew Rynhard Date: Sat, 12 Jan 2019 19:48:45 -0800 Subject: [PATCH] docs: update README Signed-off-by: Andrew Rynhard --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index d91c4426..762f6ea2 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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: