]> granicus.if.org Git - pgbadger/commitdiff
Tells to maintain DESCRIPTION in pod
authorÉtienne BERSAC <etienne.bersac@dalibo.com>
Wed, 22 Nov 2017 13:57:44 +0000 (14:57 +0100)
committerÉtienne BERSAC <etienne.bersac@dalibo.com>
Wed, 22 Nov 2017 13:57:44 +0000 (14:57 +0100)
CONTRIBUTING.md

index dc7692c02c87d9d268ec687faecb7ab8a9a4cfdc..e38e6898078a677e5c2488cf1c05b38bb51a1919 100644 (file)
@@ -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.