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

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
Lakhan Samani 2021-08-20 14:58:39 +05:30
parent 92a8702b3d
commit 4b03936fc1
1 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
.github/CONTRIBUTING.md vendored
View File

@ -5,19 +5,19 @@ We're so excited you're interested in helping with Authorizer! We are happy to h
## New to Open Source? ## New to Open Source?
1. Take a look at [How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github) 1. Take a look at [How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github)
2. Go thorugh the [Authorizer Code of Conduct](https://github.com/authorizerdev/authorizer/blob/main/.github/CODE_OF_CONDUCT.md) 2. Go through the [Authorizer Code of Conduct](https://github.com/authorizerdev/authorizer/blob/main/.github/CODE_OF_CONDUCT.md)
## 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(TODO: coming soon) 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:
## What to Work On? ## What to work on?
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 in the issue that you are going to work on it. 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](). We're happy to help!:raised_hands:
@ -35,17 +35,18 @@ Please ask as many questions as you need, either directly in the issue or on [Di
- OS: Linux or macOS or windows - OS: Linux or macOS or windows
- Go: (Golang)(https://golang.org/dl/) >= v1.15 - Go: (Golang)(https://golang.org/dl/) >= v1.15
### Familiarize yourself with `authorizer` ### Familiarize yourself with Authorizer
1. [Architecture of authorizer](TODO) 1. [Architecture of Authorizer](TODO)
2. [authorizer code and file structure overview](TODO) 2. [authorizer code and file structure overview](TODO)
### Project Setup ### 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](TODO)
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 `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`