devstack/authorizer
4
0
Fork 0
Code Pull Requests Actions Activity

fix: contributing instructions

Browse Source
This commit is contained in:
Lakhan Samani 2021-09-01 23:09:13 +05:30
parent d358523613
commit af3222b5e0
1 changed files with 5 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
.github/CONTRIBUTING.md vendored
View File

@ -10,7 +10,7 @@ We're so excited you're interested in helping with Authorizer! We are happy to h
## Where to ask questions? ## Where to ask questions?
1. Check our [Github Issues](https://github.com/authorizerdev/authorizer/issues) to see if someone has already answered your question. 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: 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) 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 🙂. 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 ### 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 ### Familiarize yourself with Authorizer
1. [Architecture of Authorizer](TODO) 1. [Architecture of Authorizer](http://docs.authorizer.dev/)
2. [authorizer code and file structure overview](TODO) 2. [GraphQL APIs](https://docs.authorizer.dev/core/graphql-api/)
### Project Setup for Authorizer core ### Project Setup for Authorizer core
1. Fork the [authorizer](https://github.com/authorizerdev/authorizer) repository (**Skip this step if you have access to repo**) 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` 2. `git clone https://github.com/authorizerdev/authorizer.git`
3. `cd authorizer` 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` 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 > 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` 6. Run binary `./build/server`