From 3b8ccfaccf7217aad747c56024c7c77e8120a003 Mon Sep 17 00:00:00 2001 From: "Alexander \"PapaTutuWawa" Date: Sat, 6 Aug 2022 11:26:47 +0200 Subject: [PATCH] docs: Add gitlint to README --- .gitlint | 4 ++-- README.md | 3 +++ 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/.gitlint b/.gitlint index 55f4b7e..ee428db 100644 --- a/.gitlint +++ b/.gitlint @@ -5,6 +5,6 @@ line-length=72 [title-trailing-punctuation] [title-hard-tab] [title-match-regex] -regex=^(feat|fix|test|release|chore|security):.*$ +regex=^(feat|fix|test|release|chore|security|docs):.*$ [body-trailing-whitespace] -[body-first-line-empty] \ No newline at end of file +[body-first-line-empty] diff --git a/README.md b/README.md index b5f9833..bbc2b43 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,9 @@ the stanza format of your preferred XMPP library yourself. When submitting a PR, please run the linter using `dart analyze` and make sure that all tests still pass using `dart test`. +To ensure uniform commit message formatting, please also use `gitlint` to lint your commit +messages' formatting. + ## License Licensed under the MIT license.