UGA-Innovation-Factory/athenix
3
1
Fork 0
Code Issues Pull Requests Actions Projects Releases Activity

update copilot instructions

Browse Source
This commit is contained in:
Hunter Halloran
2025-12-17 09:38:52 -05:00
parent 2c266cb10a
commit aee73dd1c3
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
.github/copilot-instructions.md vendored
View File

@@ -14,7 +14,7 @@ This is a **NixOS system configuration repository** that uses:
## Code Style and Conventions ## Code Style and Conventions
### Nix Code Style ### Nix Code Style
- Use the repository's formatter: `nix fmt` (uses `nixfmt-rfc-style`) - Use the repository's formatter: `nix fmt **/*.nix` (uses `nixfmt-rfc-style`)
- Follow existing indentation (2 spaces) - Follow existing indentation (2 spaces)
- Use descriptive variable names - Use descriptive variable names
- Add comments for complex logic, especially in host generation - Add comments for complex logic, especially in host generation
@@ -126,7 +126,7 @@ ugaif.forUser = "username"; # Convenience: enable user + set WSL user
- **Always** preserve existing comment styles and documentation - **Always** preserve existing comment styles and documentation
- **Always** test that configurations build successfully - **Always** test that configurations build successfully
- **Always** consider impact on existing hosts when making changes - **Always** consider impact on existing hosts when making changes
- **Always** use `nix fmt` to format code before committing - **Always** use `nix fmt **/*.nix` to format code before committing
## External Module Integration ## External Module Integration
@@ -197,8 +197,8 @@ Set via `ugaif.host.buildMethods`:
### Common Issues ### Common Issues
1. **Build failures**: Run `nix flake check --show-trace` for detailed errors 1. **Build failures**: Run `nix flake check --show-trace` for detailed errors
2. **External modules not loading**: Check URL accessibility and module structure 2. **External modules not loading**: Check URL accessibility and module structure
3. **User not appearing**: Ensure user is in `enabledUsers` for that host 3. **User not appearing**: Ensure user is enabled for that host
4. **Formatting issues**: Run `nix fmt` to auto-format 4. **Formatting issues**: Run `nix fmt **/*.nix` to auto-format
### Getting Help ### Getting Help
- Review existing documentation: `README.md`, `USER_CONFIGURATION.md`, `EXTERNAL_MODULES.md` - Review existing documentation: `README.md`, `USER_CONFIGURATION.md`, `EXTERNAL_MODULES.md`