diff options
| author | Lukáš Ondráček <lukas.ondracek@nic.cz> | 2024-10-21 19:48:46 +0200 |
|---|---|---|
| committer | Lukáš Ondráček <lukas.ondracek@nic.cz> | 2024-10-21 19:49:14 +0200 |
| commit | 308b61863d52a78292c78e9c637483e2d193e9fb (patch) | |
| tree | 54e1847aacb14c6ef3d0c06502fbe9df52da2214 /doc | |
| parent | pytests: change log level from debug to notice (diff) | |
| parent | Merge !1621: python: Ruff linter and formatter (diff) | |
| download | knot-resolver-308b61863d52a78292c78e9c637483e2d193e9fb.tar.xz knot-resolver-308b61863d52a78292c78e9c637483e2d193e9fb.zip | |
Merge remote-tracking branch 'master' into rrl-wip
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/dev/manager-dev-env.rst | 19 |
1 files changed, 6 insertions, 13 deletions
diff --git a/doc/dev/manager-dev-env.rst b/doc/dev/manager-dev-env.rst index 7178bc93..75992ba5 100644 --- a/doc/dev/manager-dev-env.rst +++ b/doc/dev/manager-dev-env.rst @@ -95,25 +95,18 @@ When invoked globally, you don't have to worry about virtual environments and su Or, you can create a symlink to the ``./poe`` script without installing PoeThePoet, e.g. ``ln -s path_to_the_repository/manager/poe /usr/bin/poe``. To list all the available commands, you can run ``poe help``. -The commands are defined in the ``pyproject.toml`` file. -The most important ones for everyday development are: - -- ``poe configure`` to configure the build directory of ``kresd`` -- ``poe run`` to run the manager -- ``poe docs`` to create HTML documentation -- ``poe test`` to run unit tests (enforced by our CI) -- ``poe check`` to run static code analysis (enforced by our CI) -- ``poe format`` to autoformat the source code -- ``poe kresctl`` to run the manager's CLI tool +The commands are defined in the ``pyproject.toml`` file of the ``tool.poe.tasks +`` section. With this environment, **everything else should just work**. You can run the same checks that CI runs, all the commands listed below should pass. If something fails and you have done all the steps above, please [open a new issue](https://gitlab.nic.cz/knot/knot-resolver-manager/-/issues/new). + Contributing ============ -Before committing, please ensure that both ``poe check`` and ``poe test`` pass. +Before committing, please ensure that ``poe check``, ``poe lint``, ``poe format`` and ``poe test`` pass. Those commands are both run on the CI and if they don't pass, CI fails. @@ -184,8 +177,8 @@ Automatically managed dependencies: Used for simplifying interactions with the project. - ``pytest``, ``pytest-cov``: unit testing -- ``pylint``, ``flake8``: linting -- ``black``: autoformatter (might be removed in the future if not used in practice) +- ``ruff``: linting and formatting +- ``mypy``: type checking Why Poetry? Why should I learn a new tool? |