hasura/graphql-engine
1
0
Fork 0
mirror of https://github.com/hasura/graphql-engine.git synced 2024-09-20 15:09:02 +03:00
Code Issues Projects Releases Wiki Activity
048c067fa1
graphql-engine/cli/CONTRIBUTING.md
shahidhk 5dc47d2ff5 [cli] commit realize, update docs
2018-06-28 11:35:34 +05:30

1.1 KiB
Raw Blame History

Contributing

You can follow your existing Golang workflow to fork, work on a branch and submit PR. If you're new to forking and working on Golang repositories, please follow the instructions below to make sure the import paths are correct.

  • Fork the repo
  • mkdir -p $GOPATH/src/github.com/hasura
  • cd $GOPATH/src/github.com/hasura
  • git clone https://github.com/<your-username>/graphql-engine
  • cd graphql-engine
  • git remote add upstream https://github.com/hasura/graphql-engine
  • git checkout -b <branch-name>
  • Work on the feature/fix
  • Add tests and ensure all tests are passing (make test)
  • Commit, push and submit PR

Development workflow

We suggest using realize for faster dev workflow. The .realize config is already included in the repo.

  • Install realize 
    go get github.com/oxequa/realize
  • Start realize 
    realize start

realize watches the directory for changes and rebuilds the cli whenever a new change happens. The cli is installed to $GOPATH/bin/hasura, which should already be in your PATH. The config is located at .realize/realize.yaml.