2018-07-11 07:57:03 +03:00
|
|
|
# Contributing
|
|
|
|
|
|
2018-07-11 13:34:29 +03:00
|
|
|
This guide is for setting-up the graphql-engine server for development on your
|
|
|
|
|
own machine, and how to contribute.
|
|
|
|
|
|
|
|
|
|
## Pre-requisites
|
|
|
|
|
|
|
|
|
|
- [stack](https://docs.haskellstack.org/en/stable/README/#how-to-install)
|
|
|
|
|
- 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
|
2018-07-16 16:57:13 +03:00
|
|
|
- `cd graphql-engine/server`
|
2018-07-11 13:34:29 +03:00
|
|
|
- `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 testcases if relevant
|
|
|
|
|
|
|
|
|
|
### Test
|
|
|
|
|
- Run tests: `stack test --ta --database-url=<database-url>`
|
|
|
|
|
|
|
|
|
|
### Create Pull Request
|
|
|
|
|
- Make sure your commit messages meet the [guidelines](../CONTRIBUTING.md).
|
|
|
|
|
- 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](https://github.com/ndmitchell/hlint) to make sure your code has no warnings.
|
|
|
|
|
- Use [stylish-haskell](https://github.com/jaspervdj/stylish-haskell) to format your code.
|
