Skip to content

Latest commit

Β 

History

History
37 lines (21 loc) Β· 1.18 KB

CONTRIBUTING.md

File metadata and controls

37 lines (21 loc) Β· 1.18 KB

Contributing to Fluent PostgreSQL

πŸ‘‹ Welcome to the Vapor team!

Bootstrap

To prepare your computer for developing this package, you can run the bootstrap script.

./contribute_boostrap.sh

This script will start up a PostgreSQL docker container to test against. It will also generate and open Xcode for you.

Be careful to observe the script's output, it may have errors or ask you to do additional steps manually.

Testing

Once in Xcode, select the FluentPostgreSQL-Package scheme and use CMD+U to run the tests.

Please add tests to cover bug fixes and new features.

If you are fixing a single GitHub issue in particular, you can add a test named testGH<issue number> to ensure that your fix is working. This will also help prevent regression.

SemVer

Vapor follows SemVer. This means that any changes to the source code that can cause existing code to stop compiling must wait until the next major version to be included.

Code that is only additive and will not break any existing code can be included in the next minor release.


Join us on Slack if you have any questions: http://vapor.team.

β€” Thanks! πŸ™Œ