From b4b3b1a3c0e738bc051aad5409443998d8e20a3c Mon Sep 17 00:00:00 2001 From: khaneliman Date: Tue, 24 Jun 2025 01:58:06 +0000 Subject: [PATCH] deploy: d07e9cceb4994ed64a22b9b36f8b76923e87ac38 --- index.xhtml | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/index.xhtml b/index.xhtml index 06a174b3c..0480b51ce 100644 --- a/index.xhtml +++ b/index.xhtml @@ -773,7 +773,7 @@ programs.home-manager.path = "$HOME/devel/home-manager";

and running home-manager switch to activate the change. Afterwards, home-manager build and home-manager switch will use your cloned repository.

The first option is good if you only temporarily want to use your clone.

-

Guidelines

Maintain backward compatibility
Keep forward compatibility in mind
Add only valuable options
Add relevant tests
Add relevant documentation
Add yourself as a module maintainer
Format your code
Format your commit messages
Format your news entries
Use conditional modules and news
Mind the license
Commits
Example commit
Code Style

If your contribution satisfy the following rules then there is a good +

Guidelines

Maintain backward compatibility
Keep forward compatibility in mind
Add only valuable options
Add relevant tests
Add relevant documentation
Module Auto-importing
Add yourself as a module maintainer
Format your code
Format your commit messages
Format your news entries
Use conditional modules and news
Mind the license
Commits
Example commit
Code Style

If your contribution satisfy the following rules then there is a good chance it will be merged without too much trouble. The rules are enforced by the Home Manager maintainers and to a lesser extent the Home Manager CI system.

If you are uncertain how these rules affect the change you would like to @@ -822,6 +822,22 @@ $ xdg-open ./result/share/doc/home-manager/index.xhtml the man page version of the module options looks good:

$ nix-build -A docs.manPages
 $ man ./result/share/man/man5/home-configuration.nix.5.gz
+

Module Auto-importing

Home Manager automatically imports all modules from the modules/programs/ and +modules/services/ directories. This auto-importing behavior follows these +rules:

  • Nix files: All .nix files in these directories are automatically +imported

  • Directories: All subdirectories are automatically imported (typically +containing a default.nix file)

  • Exclusions: Files and directories starting with an underscore (_) are +excluded from auto-importing

This allows for flexible module organization:

modules/programs/
+├── git.nix              # Single-file module (imported)
+├── firefox/             # Multi-file module (imported)
+│   ├── default.nix
+│   └── addons.nix
+├── _experimental.nix    # Excluded (starts with _)
+└── _wip/                # Excluded directory (starts with _)
+    └── newfeature.nix
+

When adding a new module, simply place it in the appropriate directory +(programs/ for user programs, services/ for user services) and it will be +automatically discovered and included in the Home Manager module system.

Add yourself as a module maintainer

Every new module must include a named maintainer using the meta.maintainers attribute. If you are a user of a module that currently lacks a maintainer then please consider adopting it.

If you are present in the nixpkgs maintainer list then you can use that