Skip to content

Contributing

This project is maintained by Angel Gonzalez and accepts focused pull requests that improve configuration, safety, documentation, tests, or portability.

The canonical workflow lives in the repository CONTRIBUTING.md.

Local Validation

sh
npm ci
bbldr dotfiles check

From a fresh clone where bbldr is not registered yet:

sh
bin/bbldr-dotfiles check

The suite validates shell scripts, isolated homes, dry-run, command collisions, install, restore, uninstall, docs links, application configs, VitePress, and Git whitespace.

Change Contract

ChangeRequired companion work
New public commandUpdate command reference, help, and CLI tests.
Installer behaviorUpdate install, security, recovery docs, and isolated tests.
Application behaviorUpdate its app page with exact commands and shortcuts.
New packageUse scaffold, complete registry metadata, docs, assets, and lifecycle tests.
Agent workflowUpdate the neutral playbook and both skill entry points.

Never commit secrets, credentials, histories, caches, generated application state, or machine-specific private paths.