Skip to content

Latest commit

 

History

History
51 lines (33 loc) · 1.12 KB

CONTRIBUTING.md

File metadata and controls

51 lines (33 loc) · 1.12 KB
Raw

Contributing to Open Pages

Welcome! Open Pages is always looking for contributors.

Getting Started with Development

  1. Fork the repository from GitHub UI

  2. Clone the forked repository:

    git clone https://github.com/your-github-profile/open-pages.git
# Alternatively, use ssh
git clone [email protected]:your-github-profile/open-pages.git

  3. Install poetry, a Python package manager. See the official documentation.

  4. Install dependencies:

    poetry install

  5. Initialize pre-commit hooks:

    poetry run pre-commit install

  6. Run the development server:

    poetry run fastapi dev open_pages/main.py

    You can also run tests:

    poetry run pytest

Commits

Create new branch, commit and push your changes to this new branch. Please, follow conventional commit guidelines for commit naming.

Submitting changes

Open Pull Request from your forked repository branch to the master branch in the main repository. Provide description of your changes and make sure the pipeline is green.