Skip to content

Latest commit

 

History

History
46 lines (33 loc) · 1.06 KB

CONTRIBUTING.md

File metadata and controls

46 lines (33 loc) · 1.06 KB

Developer Guide

This document will explain how to contribute to the edit-python.pe project.

How to Contribute

  1. Make sure to find an open issue on GitHub.
  2. Fork the edit-python.pe repository.
  3. Clone the forked repository to your local machine.
  4. Install uv.
  5. Install dependencies:
uv sync
  1. Install pre-commit hook:
uv run pre-commit install
  1. Make your changes.
  2. Cover your changes with tests.
  3. Run the test coverage:
./test/test.sh
  1. Run the auto-translations:
./bin/translate.sh
  1. Commit your changes, if the pre-commit hook fails, run ./bin/test.sh to know which test failed.
  2. If the last step was your last commit on this issue, run this command:
uv run ./bin/bump-version.sh
  1. Push your changes to the forked repository.
  2. Open a pull request on GitHub.