From: Étienne BERSAC <etienne.bersac@dalibo.com>
Date: Wed, 22 Nov 2017 13:57:44 +0000 (+0100)
Subject: Tells to maintain DESCRIPTION in pod
X-Git-Tag: v10.0~30^2
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=cc3e2cbb7ae6310d14f36018b26d3ca6318ecaf7;p=pgbadger

Tells to maintain DESCRIPTION in pod
---

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index dc7692c..e38e689 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -17,9 +17,10 @@ setup consistent spacing in files. Please follow it!
 
 ## Keep Documentation Updated
 
-The first pgBadger documentation is `pgbadger --help`. `--help` is
-injected in `doc/pgBadger.pod`. `README` is the text formatting of
-`doc/pgBadger.pod`. Update `README` and `doc/pgBadger.pod` with `make
-README`.
+The first pgBadger documentation is `pgbadger --help`. `--help` fills the
+SYNOPSIS section in `doc/pgBadger.pod`. The DESCRIPTION section *must* be
+written directly in `doc/pgBadger.pod`. `README` is the text formatting of
+`doc/pgBadger.pod`. Update `README` and `doc/pgBadger.pod` with `make README`
+and commit changes when contributing.
 
 A job in CI ensure all versionned documentations are consistent.