Harald Hoyer
74d672a18e
- Introduce guidelines for building, configuration, and formatting. - Detail repository structure and style conventions. - Provide instructions for module creation and best practices.
28 lines
1.2 KiB
Markdown
28 lines
1.2 KiB
Markdown
# NixCfg Development Guidelines
|
|
|
|
## Build and Configuration Commands
|
|
- Update NixOS: `nixos-rebuild --flake .#[hostname] switch`
|
|
- Update Darwin: `darwin-rebuild --flake .#[hostname] switch`
|
|
- Update Home Manager: `home-manager --flake .#[user]@[hostname] switch`
|
|
- Format code: `nix fmt` (uses nixfmt-rfc-style)
|
|
- Check configuration: `nix flake check`
|
|
|
|
## Repository Structure
|
|
- `modules/` - Reusable configuration modules
|
|
- `systems/` - System-specific configurations
|
|
- `homes/` - Home Manager user configurations
|
|
- `lib/` - Helper functions and utilities
|
|
|
|
## Style Guidelines
|
|
- Use `metacfg` namespace for all options
|
|
- Follow existing module structure: always use `mkEnableOption` + `mkIf` pattern
|
|
- Naming: use kebab-case for files/directories, camelCase for options
|
|
- Keep system-specific config in appropriate directories, extract common functionality to modules
|
|
- Include sufficient documentation in code for complex functions
|
|
- Commit messages should follow conventional commit format
|
|
|
|
## Module Creation
|
|
- Create new modules in appropriate category under modules/
|
|
- Use existing modules as templates for structure
|
|
- Always define options with types and descriptions
|
|
- Prefer using existing NixOS/Home Manager modules over custom implementations |