Contributing

Any kind of contribution is more than welcomed! There are several ways you can contribute:

• Opening GitHub issues to list the bugs you've found
• Implementation of new features or resolution of existing bugs
• Enhancing the documentation

How fleur works

Here how it wokrs

Setting up your environment

Install for development

• Fork the repository to your own GitHub account.

• Clone your forked repository to your local machine (ensure you have Git installed):

git clone https://github.com/your_name/fleur.git
cd fleur

• Create a new branch:

git checkout -b my-feature

• Set up your Python environment (ensure you have uv installed):

uv sync --all-groups
uv pip install -e .

Code!

You can now make changes to the package and start coding!

Run the test

• Test that everything works correctly by running:

uv run pytest

Preview documentation locally

uv run mkdocs serve

Push changes

• Commit and push your changes:

git add -A
git commit -m "description of what you did"
git push

• Go back to your fork and click on the "Open a PR" popup

Congrats! Once your PR is merged, it will be part of fleur.