mirror of
https://github.com/gwebu-team/profile.d.git
synced 2025-12-09 04:05:46 +00:00
1.6 KiB
1.6 KiB
AGENTS.md - Repository Guidelines for Agentic Coding
Build & Development Commands
make help- Show all available targetsmake dist- Create source distribution in dist/make rpm- Build RPM packagemake podman_rpm- Build RPM using podman (for MacOS)make changelog- Add changelog entry via ./changelog.shmake check- Run shellcheck on all shell scriptsmake fmt- Format all shell scripts with shfmtmake clean- Clean generated files- Pre-commit hooks run automatically on commit (see .pre-commit-config.yaml)
Code Style Guidelines
- Shell Scripts: Use bash syntax, source-safe with
${BASH_SOURCE-}guard - File Permissions: profile.d scripts must be 0644 (install -m 0644) - they are sourced, not executed
- Line Endings: LF only (enforced by pre-commit, see .editorconfig)
- No trailing whitespace (enforced by pre-commit, see .editorconfig)
- Error Handling: Use
command -vinstead ofwhichfor portability,set -euo pipefail - OS Compatibility: Support both Linux and MacOS with conditional logic
- Naming: Profile.d files use
z-<name>.shpattern for alphabetical loading - Licensing: The Unlicense unless explicitly stated otherwise
- Indentation: 4 spaces for shell scripts (see .editorconfig)
- Large Files: Max 64KB (enforced by pre-commit)
Testing
- No specific testing framework currently used
- Use
make checkto lint shell scripts with shellcheck - Shell scripts should be tested with basic manual verification
Cursor/Copilot Rules
- No specific .cursorrules or .github/copilot-instructions.md found
- Follow standard shell script best practices