chore: update contributing.md

This commit is contained in:
Lakhan Samani 2021-08-09 13:57:26 +05:30
parent 2ea47fc316
commit 3b49790ce4

View File

@ -5,3 +5,47 @@ 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)
## 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
As you gain experience with authorizer, please help answer other people's questions! :pray:
## What to Work On?
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.
Please ask as many questions as you need, either directly in the issue or on [Discord](). We're happy to help!:raised_hands:
### Contributions that are ALWAYS welcome
1. More tests
2. Improved Docs
3. Improved error messages
4. Educational content like blogs, videos, courses
## Development Setup
### Prerequisites
- OS: Linux or macOS or windows
- Go: (Golang)(https://golang.org/dl/) >= v1.15
### Familiarize yourself with `authorizer`
1. [Architecture of authorizer](TODO)
2. [authorizer code and file structure overview](TODO)
### Project Setup
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. `mv .env.sample .env`. Check all the supported env [here](TODO)
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
6. Run binary `./build/server`