hasura/graphql-engine
1
0
Fork 0
mirror of https://github.com/hasura/graphql-engine.git synced 2024-12-14 08:02:15 +03:00
Code Issues Projects Releases Wiki Activity

update cli contributing guide (#1412)

Browse Source
This commit is contained in:
Shahidh K Muhammed 2019-01-22 12:10:59 +05:30 committed by GitHub
parent c09541f4f7
commit ace701a24a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
cli/CONTRIBUTING.md
View File

@ -2,11 +2,23 @@
Thanks for your interest in Hasura GraphQL Engine CLI.
The CLI is written in [Go](https://golang.org/) using the popular
package [`spf13/cobra`](https://github.com/spf13/cobra).
All CLI related issues are labelled as [`c/cli`](https://github.com/hasura/graphql-engine/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3Ac%2Fcli+) which stands for
component/cli. If you're new to the CLI codebase, you can checkout the
[`good-first-issue`](https://github.com/hasura/graphql-engine/issues?q=is%3Aissue+is%3Aopen+label%3Ac%2Fcli+label%3A%22good+first+issue%22) label for issues that
are fairly easy to implement.
For first-time contributors, we have set aside some time slots for
one-on-one pair programming with the team, to get you started quickly. :smile:
If you're interested in setting up a chat, please feel free to pick a slot
from [shahidhk](https://github.com/shahidhk)'s [calendar](https://calendly.com/shahidhk).
## Pre-requisites
- [Go 1.10](https://golang.org/doc/install)
- [GNU Make](https://www.gnu.org/software/make/)
- [Go >= 1.10](https://golang.org/doc/install)
- [GNU Make](https://www.gnu.org/software/make/) (optional)
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