LBRYCommunity/sqlboiler
1
0
Fork 0
Code Issues Pull requests 1 Projects Releases Packages Wiki Activity

Add contribution guidelines

Browse source
This commit is contained in:
Aaron 2017-04-16 11:57:06 -07:00
parent 91950e711e
commit 5a33894412
1 changed files with 60 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

60
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,60 @@
# Contributing
Thanks for your interest in contributing to SQLBoiler!
We have a very lightweight process and aim to keep it that way.
Read the sections for the piece you're interested in and go from
there.
If you need quick communication we're usually on [Slack](https://sqlboiler.from-the.cloud).
# New Code / Features
## Small Change
#### TLDR
1. Open PR against **dev** branch with explanation
1. Participate in Github Code Review
#### Long version
For code that requires little to no discussion, please just open a pull request with some
explanation against the **dev** branch. All code goes through dev before going out in a release.
## Bigger Change
#### TLDR
1. Start proposal of idea in Github issue
1. After design concensus, open PR with the work against the **dev** branch
1. Participate in Github Code Review
#### Long version
If however you're working on something bigger, it's usually better to check with us on the idea
before starting on a pull request, just so there's no time wasted in redoing/refactoring or being
outright rejected because the PR is at odds with the design. The best way to accomplish this is to
open an issue to discuss it. It can always start as a Slack conversation but should eventually end
up as an issue to avoid penalizing the rest of the users for not being on Slack. Once we agree on
the way to do something, then open the PR against the **dev** branch and we'll commence code review
with the Github code review tools. Then it will be merged into dev, and later go out in a release.
# Bugs
Issues should be filed on Github, simply use the template provided and fill in detail. If there's
more information you feel you should give use your best judgement and add it in, the more the better.
See the section below for information on providing database schemas.
Bugs that have responses from contributors but no action from those who opened them after a time
will be closed with the comment: "Stale"
## Schemas
A database schema can help us fix generation issues very quickly. However not everyone is willing to part
with their database schema for various reasons and that's fine. Instead of providing the schema please
then provide a subset of your database (you can munge the names so as to be unrecognizable) that can
help us reproduce the problem.
*Note:* Your schema information is included in the output from `--debug`, so be careful giving this
information out publicly on a Github issue if you're sensitive about this.