Skip to content

Commit

Permalink
Add CONTRIBUTING.md for contributing guidelines
Browse files Browse the repository at this point in the history
This also lets us hook into the slick interface that GitHub provides:
https://github.com/blog/1184-contributing-guidelines
  • Loading branch information
Maciek Sakrejda committed Oct 7, 2013
1 parent 4a6b3a8 commit 0cbf7d2
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
## Contributing to pq

`pq` has a backlog of pull requests, but contributions are still very
much welcome. You can help with patch review, submitting bug reports,
or adding new functionality. There is no formal style guide, but
please conform to the style of existing code and general Go formatting
conventions when submitting patches.

### Patch review

Help review existing open pull requests by commenting on the code or
proposed functionality.

### Bug reports

We appreciate any bug reports, but especially ones with self-contained
(doesn't depend on code outside of pq), minimal (can't be simplified
further) test cases. It's especially helpful if you can submit a pull
request with just the failing test case (you'll probably want to
pattern it after the tests in
[conn_test.go](https://github.com/lib/pq/blob/master/conn_test.go).

### New functionality

There are a number of pending patches for new functionality, so
additional feature patches will take a while to merge. Still, patches
are generally reviewed based on usefulness and complexity in addition
to time-in-queue, so if you have a knockout idea, take a shot. Feel
free to open an issue discussion your proposed patch beforehand.

0 comments on commit 0cbf7d2

Please sign in to comment.