granicus.if.org Git - pgbadger/blob - CONTRIBUTING.md

   1 # How to contribute
   2
   3 ## Before Submitting an issue
   4
   5 1. Upgrade to the latest version of pgBadger and see if the problem remains
   6
   7 2. Look at the [closed issues](https://github.com/darold/pgbadger/issues?state=closed), we may have already answered a similar problem
   8
   9 3. [Read the doc](http://pgbadger.darold.net/documentation.html). It is short and useful.
  10
  11
  12 ## Coding style
  13
  14 pgBadger project provides a [.editorconfig](http://editorconfig.org/) file to
  15 setup consistent spacing in files. Please follow it!
  16
  17
  18 ## Keep Documentation Updated
  19
  20 The first pgBadger documentation is `pgbadger --help`. `--help` fills the
  21 SYNOPSIS section in `doc/pgBadger.pod`. The DESCRIPTION section *must* be
  22 written directly in `doc/pgBadger.pod`. `README` is the text formatting of
  23 `doc/pgBadger.pod`. Update `README` and `doc/pgBadger.pod` with `make README`
  24 and commit changes when contributing.
  25