45 lines (32 loc) · 1.37 KB

Contributing

This guide is for setting-up the graphql-engine server for development on your own machine, and how to contribute.

Pre-requisites

stack
A Postgres server (Recommended: Use docker to run a local postgres instance)
GNU Make (optional)

Development workflow

Fork and clone

Fork the repo on GitHub
Clone your forked repo: git clone https://github.com/<your-username>/graphql-engine

Compile

cd graphql-engine/server
stack build --fast

Run

Make sure postgres is running
Create a database on postgres
Run the binary: stack exec graphql-engine -- --database-url=<database-url>

Work

Work on the feature/fix
Add test cases if relevant

Test

Run tests: stack test --ta --database-url=<database-url>

Create Pull Request

Make sure your commit messages meet the guidelines.
Create a pull request from your forked repo to the main repo.
Every pull request will automatically build and run the tests.

Code conventions

This helps enforce a uniform style for all committers.

Compiler warnings are turned on, make sure your code has no warnings.
Use hlint to make sure your code has no warnings.
Use stylish-haskell to format your code.