Skip to content

Latest commit

 

History

History
38 lines (24 loc) · 1.76 KB

CONTRIBUTING.md

File metadata and controls

38 lines (24 loc) · 1.76 KB
Raw

Welcome to the PyNotion Contribution Community!

We're thrilled that you're interested in helping out with the development of PyNotion! Every contribution, no matter how small, makes a difference and helps keep this project moving forward.

Here's what you need to know to get started:

Creating an Issue

To report a bug or request a new feature, please use the appropriate issue template:

  1. Bug Report Template
  2. Feature Request Template

Not sure which template to use? No problem, you can also create a custom issue to describe what you need.

Setting up Your Development Environment

To get started with development, follow these steps:

  1. Fork the repository and clone it to your local machine with git clone [email protected]:<username>/PyNotion.git
  2. Install Poetry with pip install poetry or pip3 install poetry
  3. Navigate to the project root and run poetry install
  4. Set up pre-commit hooks by running pre-commit install and then pre-commit migrate-config

Submitting a Pull Request

Here's what you need to do to submit a pull request:

  1. Create a branch off the main branch with a descriptive name that reflects what you're working on.
  2. Make your changes and test them thoroughly.
  3. Submit a pull request and assign at least one reviewer.
  4. Respond to feedback from the review and make any necessary changes.

Before submitting your pull request, please make sure that your changes align with the Code of Conduct.

Thanks for your support, and happy coding!