contributing
Create commits and pull requests following conventions
Installation
Follow the repository instructions for this skill and your agent. Review the files and dependencies before adding it to your workflow.
View source ↗GuidesSkill instructions
Contributing
Pre-Submission Checklist
Before submitting changes:
- Run
nix fmtto format code - Run
nix flake check(with devenv-root override) - Test at least one affected host configuration
- Test at least one affected home configuration (if applicable)
- Verify commit message follows conventions
Commit Message Format
Use conventional commit format:
type(scope): brief summary
Optional body explaining why the change was made.
Types
| Type | Use For |
|---|---|
feat |
New feature or capability |
fix |
Bug fix |
chore |
Maintenance, dependencies |
refactor |
Code restructuring without behavior change |
build |
Build system changes |
ci |
CI/CD changes |
style |
Formatting, whitespace |
Scopes
Scope should be the common directory path:
| Scope | Example |
|---|---|
home/racci |
Changes to racci's home config |
hosts/server |
Changes affecting server hosts |
hosts/server/nixdev |
Changes specific to nixdev |
modules/nixos |
NixOS module changes |
modules/home-manager |
Home-Manager module changes |
pkgs |
Package changes |
lib |
Library function changes |
Examples
feat(hosts/server/nixdev): add woodpecker CI runner
fix(modules/nixos/services): correct tailscale firewall rules
chore(flake): update nixpkgs input
refactor(lib/builders): simplify mkSystem arguments
Pull Request Guidelines
- Title should mirror the commit header
- Link related issues:
Closes #123orFixes #123 - Describe changes and reasoning in the PR body
- Ensure CI passes before requesting review
PR Description Template
## Summary
Brief description of what this PR does and why.
## Changes
- Change 1
- Change 2
## Testing
- Tested on: <hostname>
- Home config tested: <user>@<host>
Closes #<issue>
Examples
Read the usage examples in the source repository.
View source ↗Source history
- Indexed on
- 2026-01-20
- Index updated
- 2026-01-26
- Branch
- main
Index and sync dates describe this directory. View the source repository for code history.
GitHub ↗chat Comments (0)
Sign in to join the discussion and leave a comment.
No comments yet. Be the first to share your thoughts!