devstack/authorizer
4
0
Fork 0
Code Pull Requests Actions Activity
authorizer/.github/CONTRIBUTING.md
Lakhan Samani 8fc0175166
Update CONTRIBUTING.md
2021-12-24 10:05:05 +05:30

3.2 KiB
Raw Blame History

Contributing

We're so excited you're interested in helping with Authorizer! We are happy to help you get started, even if you don't have any previous open-source experience 😊

New to Open Source?

  1. Take a look at How to Contribute to an Open Source Project on GitHub
  2. Go through the Authorizer Code of Conduct

Where to ask questions?

  1. Check our Github Issues to see if someone has already answered your question.
  2. Join our community on Discord and feel free to ask us your questions

As you gain experience with Authorizer, please help answer other people's questions! 🙏

What to work on?

You can get started by taking a look at our Github 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!🙌

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

Familiarize yourself with Authorizer

  1. Architecture of Authorizer
  2. GraphQL APIs

Project Setup for Authorizer core

  1. Fork the 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
  5. Build the code make clean && make

    Note: if you don't have make, you can cd into server dir and build using the go build command

  6. Run binary ./build/server

Testing

Make sure you test before creating PR.

If you want to test for all the databases that authorizer supports you will have to run mongodb & arangodb instances locally.

Setup mongodb & arangodb using Docker

docker run --name mongodb -d -p 27017:27017 mongo
docker run --name arangodb -d -p 8529:8529 -e ARANGO_ROOT_PASSWORD=root arangodb/arangodb:3.8.4

Note: If you are not making any changes in db schema / db operations, you can disable those db tests here

If you are adding new resolver,

  1. create new resolver test file here Naming convention filename: resolver_name_test.go function name: resolverNameTest(s TestSetup, t *testing.T)
  2. Add your tests here

Command to run tests:

make test