Skip to content

Latest commit

 

History

History
69 lines (52 loc) · 3.02 KB

CONTRIBUTING.md

File metadata and controls

69 lines (52 loc) · 3.02 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

Prerequisites

  • OS: Linux or macOS
  • IDE: Intellij (recommended) or equivalent IDE
  • MySQL

Project Setup

  1. Setup the supertokens-core by following this guide. If you are not modifying the supertokens-core repo, then you do not need to fork that.
  2. Start MySQL on port 3306, listening to locahost or 0.0.0.0.
  3. Create a MySQL user (if not already exists) with username root and password root
  4. Create a database called supertokens.
  5. Fork the supertokens-mysql-plugin repository
  6. Open modules.txt in the supertokens-root directory and change it so that it looks like (the last line has changed): 
    // put module name like module name,branch name,github username(if contributing with a forked repository) and then call ./loadModules script        
core,master
plugin-interface,master
mysql-plugin,master,<your github username>
  7. Run ./loadModules in the supertokens-root directory. This will clone your forked supertokens-mysql-plugin repo.
  8. Follow the CONTRIBUTING.md guide from supertokens-core repo for modifying and testing.

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: