diff --git a/cli/CONTRIBUTING.md b/cli/CONTRIBUTING.md index 15537a39a3f71..69bdd8570aa98 100644 --- a/cli/CONTRIBUTING.md +++ b/cli/CONTRIBUTING.md @@ -2,11 +2,23 @@ Thanks for your interest in Hasura GraphQL Engine CLI. -## Pre-requisites +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. -- [Go 1.10](https://golang.org/doc/install) -- [GNU Make](https://www.gnu.org/software/make/) +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/) (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