Skip to content

Latest commit

 

History

History
40 lines (30 loc) · 1.8 KB

CONTRIBUTING.md

File metadata and controls

40 lines (30 loc) · 1.8 KB
Raw

Hello Devs👋🏻, Thankyou for speding your valuable time to contribute to PyNotion. All PRs, contributions, reviews and suggestions are welcome. Please follow the guidelines below to contribute to this project.

Creating an Issue

Please follow the issue template while creating an issue. If you are creating an issue follow the below templates:

  1. For Bugs - Bug Template
  2. For Feature Requests

You can also use the custom template to create an issue if the above templates did not match your needs.

Setup for development

Virtual environment setup with Poetry

  1. Create a fork of the repository
  2. Clone the repository to your local machine git clone [email protected]:<username>/PyNotion.git
  3. Install poetry with pip install poetry or pip3 install poetry
  4. Navigate to the root of the project and run poetry install

Setup Pre-commit hooks

  1. Install pre-commit hooks pre-commit install
  2. Migrate pre-commit configs pre-commit migrate-config
  3. Incase of error run git config --global --unset-all core.hooksPath or git config --unset-all core.hooksPath

Creating a Pull Request

  1. Fork the repository
  2. Create a branch from the main
  3. Please have a proper name for the branch like feature or a bug related to what you are working on
  4. Once completed raise a PR and add a reviewer
  5. Once reviewed the PR will be merged

Please provide necessary changes or update if mentioned by a reviewer also stick to the CODE_OF_CONDUCT.md while adding review comments or while answering review comments.