CONTRIBUTING.md

Contributing

In order to add a new login provider, please make sure to adhere to the following guidelines to the best of your abilities and possibilities.

Dependencies management

Seing the file poetry.lock you may have guessed this project relies on Poetry to manage dependencies.

If there is a need for a 3rd party dependency in order to integrate login provider, please try to make use of extras in order not to make fastapi-sso any heavier. Any dependency apart from the ones listed in tool.poetry.dependencies in pyproject.toml should be an extra along with it being optional. If you are not shure how to do this, let me know the dependency in PR and I will add it before merging your code.

Also, please strictly separate runtime dependencies from dev dependencies.

Provide examples

Please, try to provide examples for the login provider in the examples/ directory. Always make sure your code contains no credentials before submitting the PR.

Code quality

I am myself rather a dirty programmer and so it feels a little out of place for me to talk about code quality, but let's keep the code up to at least some standards.

Formatting

As visible in pyproject.toml, I use black as a formatter with all the default settings except for the line_length parameter. 119 is the number I, partly as a joke, chose, so let's all use it.

It is easy to reformat the code by calling black from the repository root:

$ black fastapi_sso

All done! ✨ 🍰 ✨
7 files left unchanged.

Linting

I use pylint. Detailed configuration is to be found in .pylintrc file.

Check your code by calling:

$ pylint fastapi_sso

--------------------------------------------------------------------
Your code has been rated at 10.00/10 (previous run: 10.00/10, +0.00)

If the code isn't 10/10 and you feel you have a good reason for it not to be, you may use pylint: disable=... magic comments throughout the code, but please expect me to ask about it when you submit the PR.

Typechecking

Try to keep the code statically typechecked using mypy. Check that everything is alright by running:

$ mypy fastapi_sso

Success: no issues found in 7 source files

Rebuild docs

Before submitting the PR, please rebuild the docs by running ./build-docs.sh. If you cannot or do not know how to run the script, let me know in the PR and I'll add commit with the latest docs.

I'll try to automate this using Github Actions, but as I come from Gitlab, I don't feel courageous enough yet.