Skip to content

Latest commit

 

History

History
74 lines (59 loc) · 3.25 KB

CONTRIBUTING.md

File metadata and controls

74 lines (59 loc) · 3.25 KB
Raw

Contributing

We're so excited you're interested in helping with SuperTokens! 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 thorugh the SuperTokens 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

Development Setup

You will need to setup the supertokens-core in order to to run the supertokens-fastapi tests. Follow this guide to setup supertokens-core. Note: If you are NOT contributing to supertokens-core you can skip steps 1 & 4 under Project Setup of the supertokens-core contributing guide.

Prerequisites

  • OS: Linux or macOS
  • IDE: PyCharm (recommended) or equivalent IDE

Project Setup

  1. Fork the supertokens-fastapi repository
  2. Clone the forked repository in the parent directory of the previously setup supertokens-root. That is, supertokens-fastapi and supertokens-root should exist side by side within the same parent directory.
  3. cd supertokens-fastapi
  4. Create and activate the python virtal env 
    python3 -m venv env
source env/bin/activate
  5. Install the project dependencies 
    make dev-install
  6. Add git pre-commit hooks 
    make set-up-hooks

Modifying Code

  1. Open the supertokens-fastapi project in your IDE.
  2. You can start modifying the code.

Testing

  1. Navigate to the supertokens-root repository

  2. Start the testing environment

    ./startTestingEnv --wait

  3. In a new terminal, navigate to the supertokens-fastapi repository (remember to run source env/bin/activate).

  4. Run all tests

    SUPERTOKENS_PATH=../supertokens-root make test

  5. If all tests pass the output should be:

    Fastapi tests passing

Pull Request

  1. Before submitting a pull request make sure all tests have passed
  2. Reference the relevant issue or pull request and give a clear description of changes/features added when submitting a pull request

SuperTokens Community

SuperTokens is made possible by a passionate team and a strong community of developers. If you have any questions or would like to get more involved in the SuperTokens community you can check out:

Additional resources you might find useful: