From fce540024a7e87101f6dfc3b217b1f664bf0dc84 Mon Sep 17 00:00:00 2001 From: Martin Weinelt Date: Thu, 8 May 2025 18:53:25 +0200 Subject: [PATCH] docs/howto-develop: document the devshell --- docs/howto-develop.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/howto-develop.rst b/docs/howto-develop.rst index 10e53e5..40527f9 100644 --- a/docs/howto-develop.rst +++ b/docs/howto-develop.rst @@ -9,6 +9,23 @@ If you have questions, feel free to reach out: * Matrix: `#nixos-mailserver:nixos.org `__ * IRC: `#nixos-mailserver `__ on `Libera Chat `__ +All our workflows rely on Nix being configured with `Flakes `__. + +Development Shell +----------------- + +We provide a `flake.nix` devshell that automatically sets up pre-commit hooks, +which allows for fast feedback cycles when making changes to the repository. + + +:: + + $ nix develop + + +We recommend setting up `direnv `__ to automatically +attach to the development environment when entering the project directories. + Run NixOS tests ---------------