- This repository uses a devcontainer (see
.devcontainer/). Use the devcontainer CLI to run commands inside the devcontainer when possible. If the CLI is unavailable, run commands directly but note that some tools likejustmay be missing. - After opening the devcontainer,
yarn --immutableinstalls dependencies and sets up Prettier as shown in.devcontainer/post-create-command.sh. - Container images should follow the newer
build_filespattern used by images such asdevcontainer-baseandkairos-fedora: keep the Containerfile focused on stages, args, mounts, labels, and final image settings, and put package installation or setup logic in executable scripts underimages/<name>/build_files/.
- Run
just formatbefore committing to automatically format YAML, JSON and Markdown files with Prettier. Formatting rules are defined in the justfile lines 154-161. - Use
just check-formatto verify formatting (see justfile lines 6-12). - Run
just lintto execute all linters including Ansible, hadolint, kustomize, renovate, and shellcheck (see justfile lines 162-214).
- Execute
just testto run all kustomization tests. Individual component tests can be run withjust kustomization-test <component>(see justfile lines 216-234).
- Follow Conventional Commits style. Commits from
sdwilshuse types such asfeat,fix,docs,chore, andtests, optionally with!for breaking changes (e.g.,feat!: rename ...). - Keep the summary short and use the body to provide context if needed. Issue or PR references can be placed in parentheses after the summary, as seen in commits like
Add Mosquitto Kustomize Component (#74). - Signed commits are recommended as noted in commit
Support GPG Signing of Commits (#76). - Pull request titles should also follow the Conventional Commits style so that PRs and commits use consistent semantic naming.