Merge pull request #192 from supertokens/docs/contributing-guide

docs: Update CONTRIBUTING.md and mention in CHANGELOG

Author: rishabhpoddar

CHANGELOG.md

@@ -6,6 +6,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [unreleased]
 
+### Documentation
+
+- Add more details in the `CONTRIBUTING.md` to make it beginner friendly.
+
+
 ## [0.9.1] - 2022-06-27
 ### Features:
 

CONTRIBUTING.md

@@ -14,19 +14,19 @@ We're so excited you're interested in helping with SuperTokens! We are happy to
 
 ## Development Setup
 
-You will need to setup the `supertokens-core` in order to run the `supertokens-python` tests, you can setup `supertokens-core` by following this [guide](https://github.com/supertokens/supertokens-core/blob/master/CONTRIBUTING.md#development-setup)  
+You will need to setup the [supertokens-core](https://github.com/supertokens/supertokens-core) in order to run the `supertokens-python` 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
 
 -   Python (version 3.7 or above)
--   IDE: [PyCharm](https://www.jetbrains.com/pycharm/download)(recommended) or equivalent IDE
+-   IDE: [PyCharm](https://www.jetbrains.com/pycharm/download)(recommended) OR [VS Code](https://code.visualstudio.com/) OR equivalent IDE
 
 ### Project Setup
 
-1. Fork the [supertokens-python](https://github.com/supertokens/supertokens-python) repository
+1. Fork the [supertokens-python](https://github.com/supertokens/supertokens-python) repository.
 2. Clone the forked repository in the parent directory of the previously setup `supertokens-root`.
-   `supertokens-python` and `supertokens-root` should exist side by side within the same parent directory
+   `supertokens-python` and `supertokens-root` should exist side by side within the same parent directory.
 3. Create a virtual environment for the `supertokens-python` project and activate it.
 4. Install the project dependencies
    `make dev-install`
@@ -35,23 +35,25 @@ You will need to setup the `supertokens-core` in order to run the `supertokens-p
 
 ## Modifying Code
 
-1. Open the `supertokens-python` project in your IDE and you can start modifying the code
+- Open the `supertokens-python` project in your IDE and you can start modifying the code.
+- Use `make check-lint` and `make format` to find lint/formatting errors before committing. (They will run anyways)
 
 ## Testing
 
-1. Navigate to the `supertokens-root` repository
+1. Navigate to the [supertokens-root](https://github.com/supertokens/supertokens-root) repository.
 2. Start the testing environment  
    `./startTestEnv --wait`   
-   and ensure the test environment is up and running
-3. Open a new terminal and navigate to the `supertokens-python` respositry   
-4. Run all tests, while ensuring the test environment is running on a different terminal   
-   `make test`
+   and ensure the test environment is up and running.
+3. Open a new terminal and navigate to the `supertokens-python` respositry.
+4. Use `export SUPERTOKENS_PATH=path/to/supertokens-root` (**MANDATORY**)
+4. To run all tests, while ensuring the test environment is running on a different terminal, use `make test`.
+5. To run individual tests, use `pytest ./tests/path/to/test/file.py  -k test_function_name` OR use your IDE's in-built UI for running python tests. You may read [VSCode Python Testing](https://code.visualstudio.com/docs/python/testing) and [PyCharm Testing](https://www.jetbrains.com/help/pycharm/testing-your-first-python-application.html#debug-test) for more info.
 
 ## 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](https://www.conventionalcommits.org/en/v1.0.0/) specification
+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](https://www.conventionalcommits.org/en/v1.0.0/) specification.
 
 ## SuperTokens Community
 
@@ -65,4 +67,18 @@ SuperTokens is made possible by a passionate team and a strong community of deve
 Additional resources you might find useful:
 
 -   [SuperTokens Docs](https://supertokens.io/docs/community/getting-started/installation)
--   [Blog Posts](https://supertokens.io/blog/)
+-   [Blog Posts](https://supertokens.io/blog/)
+
+## Implementing RecipeInterfaces
+
+- Make sure all CRUD operations are available via the `(a)?syncio` modules of that recipe.
+- Make sure the corresponding `RecipeImplementation` takes type imports from the `interfaces.py` file of that recipe. This is so that if a user wants to copy / paste that code into their project, they can do so via the normal import statement.
+
+## Implementing APIInterfaces
+- Make sure the corresonding `APIImplementation` takes type imports from the `interfaces.py` file of that recipe. This is so that if a user wants to copy / paste that code into their project, they can do so via the normal import statement.
+
+## Generating docs
+This will generate the API docs in a folder called docs
+```
+make build-docs
+```