supertokens-node/CONTRIBUTING.md

NodeJS driver for SuperTokens core

# 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 :blush:

## 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)
2. Go thorugh the [SuperTokens Code of Conduct](https://github.com/supertokens/supertokens-node/blob/master/CODE_OF_CONDUCT.md)

## Where to ask Questions?
1. Check our [Github Issues](https://github.com/supertokens/supertokens-node/issues) to see if someone has already answered your question.  
2. Join our community on [Discord](https://supertokens.io/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-node` tests, you can setup `supertokens-core` by following this [guide](https://github.com/supertokens/supertokens-core/blob/master/CONTRIBUTING.md#development-setup)  
**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 or macOS
- Nodejs & npm
- IDE: [VSCode](https://code.visualstudio.com/download)(recommended) or equivalent IDE  

### Project Setup
1. Fork the [supertokens-node](https://github.com/supertokens/supertokens-node) repository
2. Clone the forked repository in the parent directory of the previously setup `supertokens-root`.  
`supertokens-node` and `supertokens-root` should exist side by side within the same parent directory
3. `cd supertokens-node`
4. Install the project dependencies  
`npm i -d`
5. Add git pre-commit hooks  
`npm run set-up-hooks`

## Modifying Code  
1. Open the `supertokens-node` project in your IDE and you can start modifying the code  
2. After modifying the code, build your project to implement your changes  
` npm run build-pretty`  

## Testing  
1. Navigate to the `supertokens-root` repository  
2. Start the testing environment      
`./startTestingEnv --wait`  
3. Navigate to the `supertokens-node` repository  
`cd ../supertokens-node/`  
4. Run all tests    
`INSTALL_PATH=../supertokens-root npm test`
5. If all tests pass the output should be:  
![node tests passing](https://github.com/supertokens/supertokens-logo/blob/master/images/supertokens-node-tests-passing.png) 


## 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:  
  - [Github Issues](https://github.com/supertokens/supertokens-node/issues)
  - [Discord](https://supertokens.io/discord)
  - [Twitter](https://twitter.com/supertokensio)
  - or [email us](mailto:team@supertokens.io)

Additional resources you might find useful:
  - [SuperTokens Docs](https://supertokens.io/docs/community/getting-started/installation)
  - [Blog Posts](https://supertokens.io/blog/)