Skip to content

Latest commit

 

History

History
58 lines (37 loc) · 1.4 KB

CONTRIBUTING.md

File metadata and controls

58 lines (37 loc) · 1.4 KB

Contributing to FletEasy

First off, thanks for taking the time to contribute! Contributions include but are not restricted to:

  • Reporting bugs
  • Contributing to code
  • Writing tests
  • Writing documentation

The following is a set of guidelines for contributing.

1. Install uv

For more information here.

pip install uv

2. Clone repository

git clone https://github.com/Daxexs/flet-easy.git

3. Maintain dependencies to initialize the project

Install all dependencies and create a runtime environment for python automatically.

uv sync --all-extras --all-groups

4. Code formatting and check

If you make some changes in the src/ and you want to preview the result of the code if it is optimal, just do it:

!!! info Recommended to install the Ruff extension to get the errors immediately. See here.

uv run ruff format
uv run ruff check --fix

5. Preview the documentation

If you make some changes to the docs/ and you want to preview the build result, simply do:

uv run mkdocs serve

6. Create a Pull Request

Once you have reviewed step 4 you can make the pull request with a detailed description of the new integrations or changes made to the code, with images or videos demonstrating what the code does if possible.