File: CONTRIBUTING.md

package info (click to toggle)
pgbadger 11.6-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid
  • size: 7,452 kB
  • sloc: javascript: 22,274; perl: 20,588; sh: 4; makefile: 2
file content (25 lines) | stat: -rw-r--r-- 878 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
# 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](https://github.com/darold/pgbadger/issues?state=closed), we may have already answered a similar problem

3. [Read the doc](http://pgbadger.darold.net/documentation.html). It is short and useful.


## Coding style

pgBadger project provides a [.editorconfig](http://editorconfig.org/) 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`. Update `README` and `doc/pgBadger.pod` with `make README`
and commit changes when contributing.