From cc3e2cbb7ae6310d14f36018b26d3ca6318ecaf7 Mon Sep 17 00:00:00 2001 From: =?utf8?q?=C3=89tienne=20BERSAC?= Date: Wed, 22 Nov 2017 14:57:44 +0100 Subject: [PATCH] Tells to maintain DESCRIPTION in pod --- CONTRIBUTING.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) 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. -- 2.40.0