diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index dd4debf..e34f347 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -10,7 +10,7 @@ We're so excited you're interested in helping with Authorizer! We are happy to h ## Where to ask questions? 1. Check our [Github Issues](https://github.com/authorizerdev/authorizer/issues) to see if someone has already answered your question. -2. Join our community on Discord(TODO: coming soon) and feel free to ask us your questions +2. Join our community on [Discord](https://discord.gg/WDvCxwkX) and feel free to ask us your questions As you gain experience with Authorizer, please help answer other people's questions! :pray: @@ -19,7 +19,7 @@ As you gain experience with Authorizer, please help answer other people's questi You can get started by taking a look at our [Github issues](https://github.com/authorizerdev/authorizer/issues) If you find one that looks interesting and no one else is already working on it, comment on that issue and start contributing 🙂. -Please ask as many questions as you need, either directly in the issue or on [Discord](). We're happy to help!:raised_hands: +Please ask as many questions as you need, either directly in the issue or on [Discord](https://discord.gg/WDvCxwkX). We're happy to help!:raised_hands: ### Contributions that are ALWAYS welcome @@ -37,16 +37,15 @@ Please ask as many questions as you need, either directly in the issue or on [Di ### Familiarize yourself with Authorizer -1. [Architecture of Authorizer](TODO) -2. [authorizer code and file structure overview](TODO) +1. [Architecture of Authorizer](http://docs.authorizer.dev/) +2. [GraphQL APIs](https://docs.authorizer.dev/core/graphql-api/) ### Project Setup for Authorizer core 1. Fork the [authorizer](https://github.com/authorizerdev/authorizer) repository (**Skip this step if you have access to repo**) 2. `git clone https://github.com/authorizerdev/authorizer.git` 3. `cd authorizer` -4. `cp .env.sample .env`. Check all the supported env [here](TODO) +4. `cp .env.sample .env`. Check all the supported env [here](https://docs.authorizer.dev/core/env/) 5. Build the code `make clean && make` > Note: if you don't have [`make`](https://www.ibm.com/docs/en/aix/7.2?topic=concepts-make-command), you can `cd` into `server` dir and build using the `go build` command 6. Run binary `./build/server` -