Skip to content

Latest commit

 

History

History
27 lines (18 loc) · 1.04 KB

CONTRIBUTING.md

File metadata and controls

27 lines (18 loc) · 1.04 KB
Raw

How to contribute

Before submitting an issue

  1. Upgrade to the latest version of pgBadger and see if the problem remains

  2. Look at the closed issues, we may have already answered a similar problem

  3. Read the doc, it is short and useful

Coding style

The pgBadger project provides a .editorconfig file to setup consistent spacing in files. Please follow it!

Keep documentation updated

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.

After updating doc/pdBadger.pod, rebuild README and README.md with the following commands:

$ perl Makefile.PL && make README

When you're done contributing to the docs, commit your changes. Note that you must have pod2markdown installed to generate README.md.