Contributing¶

Thank you for considering contributing to the QField plugin templater! Contributions are highly appreciated and help improve the project for everyone.

Keep in mind that this project is still in its early stages, feedback and contributions are welcome to shape its development.
Contributions of all kinds are welcome, including bug reports, feature requests, documentation improvements, and code contributions.

Contributor Covenant Code of Conduct¶

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.

This project adheres to the Contributor Covenant Code of Conduct.
See the version 2.0 for more details.

Contribution guidelines¶

If you intend to contribute to this project, you can follow these guidelines, which are not written in stone but are meant to help having a smooth and homogeneous contribution experience.

Installation and setup¶

• Install the necessary dependencies, e.g. on debian-based linux distributions:

sudo apt install -y python3-pip pre-commit

• Clone or fork the repository locally.

• Install the pre-commit hooks in the repository:

pre-commit install

Making contributions¶

• Create a new branch for your contribution, based on the main branch:

git checkout -b feat/add-my-new-super-fancy-feature
git checkout -b fix/fix-this-bug
git checkout -b docs/update-this-section-of-the-documentation

• Make your changes, then commit them ideally using conventional commit messages:

git commit -m "feat: add my new super fancy feature"
git commit -m "fix: fix this bug"
git commit -m "docs: update this section of the documentation"

Working on the doc¶

The documentation is built using uv and zensical.

• Install uv and sync the dependencies:

pipx install uv
uv sync

• Serve the documentation locally:

uv run zensical serve -f documentation/zensical.toml