This guide is intended for developers of Flowctl, people who want to contribute to the Flowctl codebase or documentation, or people who want to understand the source code of the application they're running.
There are a few things you can do ensure your environment is ready for development on Flowctl. First, ensure that you have poetry installed on your system. For more details on how to install poetry, see the Poetry documentation.
Next, clone the repo and create the virtual environment:
git clone https://gitlab.com/emergentmethods/flowctl.git
cd flowctl
python3 -m venv .venv
source .venv/bin/activateThen, install the dependencies:
poetry install --with dev???+ note "Note"
The --with dev flag is on by default, but it is good to be explicit.
Finally, install the pre-commit hooks:
pre-commit installThese are required to ensure that the code is formatted correctly and that the tests pass before committing. If you NEED to skip the pre-commit hooks, you can use the --no-verify flag when committing. However CI will still run the hooks and fail if they do not pass.
Commit messages should follow the Conventional Commits specification (specifically the Angular convention). This allows us to automatically generate changelogs and version numbers for releases. The commit message should be in the following format:
<type>[optional scope]: <description>
[optional body]
[optional footer(s)]
Changes to the CLI should come with a regenerated cli.md file. This can be done by running the following command:
flowctl dev docs cli.mdThe Flowdapt documentation includes a copy of the cli.md as a reference to the Flowctl CLI. When it has updated, create an MR in the Flowdapt repository to update the cli.md file.