Contributing guidelines
Tip
If you are a first time contributor, please start by reading this fantastic guide.
Any serious contribution to notion-sdk-py is always welcome, regardless of your experience.
If you want to contribute on the code specifically:
- Install Git and Python on your system.
- Fork the repository and clone it.
-
Checkout a new feature branch from
main
:git checkout my-feature
-
Install dependencies inside a virtual environment:
python -m venv .venv source .venv/bin/activate pip install -r requirements/dev.txt
-
Install pre-commit hooks:
pre-commit install
You should now be ready to hack!
You can run the tests with pytest
in the main directory. Please make
sure the tests (and pre-commit hooks) pass before opening a pull
request.
Coverage must stay at 100%. Write tests if you add new features.
Thanks for your help!