Contributing Guidelines

If you are a first time contributor, start by reading this fantastic guide.

1. Read the docs

   • notion-sdk-py
   • Notion API Reference
   • NotionSci

2. System Requirements

   • git
   • python
   • pipenv

3. Fork the repository and clone it. Checkout a new feature branch from master. This guide will be really helpful if you are a newbie.

4. Install dependencies inside a virtual environment.

   pipenv install
   

5. Install pre-commit hooks.

   pre-commit install
   

6. Follow the code style enforced by tools such as black, isort, flake, mypy. For markdown files, markdownlint must be followed.

7. Tests must pass. If you are adding features write tests.