Contribute

Commits

We make commits in the Style of Conventional Commits

If you're working on a new feature, please make it in a new Branch, if you're ready to merge open a merge-request, so the others can review your code and its clear what changed on main branch.

You cannot commit directly to the main branch and at least one other person has to review your code before it can be merged into the main branch.

Bundles

Bundels are different UIs for FarningCode, like CLI, in development the core Package gets copied in the

UV

you need UV

To add a new component, use the following command:

uv add <component_name>

Execute the following command to run the code:

uv run main.py

Linting

To lint your Python code using ruff and typecheck using ty, execute the following commands:

To lint your Python code using ruff.

uvx ruff check

To format your Python code using ruff:

uvx ruff format

for typechecking your Python code using ty:

uvx ty check

CiCD

The Linting and typechecking is also integrated into the CI/CD pipeline to ensure code quality before merging changes. This setup uses Woodpecker CI. The Ci/CD workflow will automatically run the linting and typechecking steps defined in the .woodpecker.yml configuration file.