Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
87 lines (64 loc) · 4.55 KB

CONTRIBUTING.md

File metadata and controls

87 lines (64 loc) · 4.55 KB

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 through 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-golang tests, you can setup supertokens-core by following this guide
Note: If you are not contributing to the supertokens-core you can skip steps 1 & 4 under Project Setup of the supertokens-core contributing guide.

Prerequisites

  • OS: Linux, macOS or WSL
  • Go
  • IDE: VSCode(recommended) or equivalent IDE

Project Setup

  1. Fork the supertokens-golang repository
  2. Clone the forked repository in the parent directory of the previously setup supertokens-root.
    supertokens-golang and supertokens-root should exist side by side within the same parent directory
  3. cd supertokens-golang
  4. You should have a go setup on your local machine

Modifying Code

  1. Open the supertokens-golang project in your IDE and you can start modifying the code

Testing

  1. Navigate to the supertokens-root repository
  2. Start the testing environment
    ./startTestEnv --wait
  3. Navigate to the supertokens-golang repository
    cd ../supertokens-golang/
  4. Run all tests, [count=1 ensures tests are not cached] INSTALL_DIR=../supertokens-root go test ./... -p 1 -v count=1
  5. If all tests pass the output should be: golang tests passing
  6. Navigate to the test-server folder within the supertokens-golang project: cd ./test/test-server/
  7. Setup for test:
    sh setup-for-test.sh
  8. Start the server: go run .
  9. In the supertokens-golang root folder, open the frontendDriverInterfaceSupported.json file and note the latest version supported. This version will be used to check out the correct version of the backend-sdk-testing project.
  10. Fork the backend-sdk-testing repository.
  11. Clone your forked repository into the parent directory of the supertokens-root project. Both supertokens-root and backend-sdk-testing should exist side by side within the same parent directory.
  12. Change to the backend-sdk-testing directory: cd backend-sdk-testing
  13. Check out the supported FDI version to be tested (as specified in frontendDriverInterfaceSupported.json): git checkout <FDI-version>
  14. Install dependencies and build the project: npm install && npm run build-pretty
  15. Run all tests (make sure to have node version >= 16.20.0 and < 17.0.0): INSTALL_PATH=../supertokens-root npm test

Note that setup-for-test.sh copies some files into the recipe folder. Ensure that these files are not committed.

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
  3. Make sure the PR title follows conventional commits specification

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: