Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
60 lines (46 loc) · 1.92 KB

CONTRIBUTING.md

File metadata and controls

60 lines (46 loc) · 1.92 KB
Raw

Contributing

Setup

This is a public macOS bootstrap framework. Keep changes portable and keep machine identity, credentials, app state, and project checkouts local.

Install the prerequisites and clone the repository:

brew install git gh
gh auth login
gh repo clone uinaf/dotfiles ~/projects/dotfiles
cd ~/projects/dotfiles
./scripts/bootstrap/brew-bundle.sh workstation
mise trust
mise install
mise run verify:domain static

Use the Bootstrap guide for a different profile or a Mac that does not yet have Homebrew, Git, or GitHub CLI.

Verify

List the domains and run the focused check that owns the change:

mise run verify:domain config # example; select the owning domain
mise run verify:fast
mise run verify
  • verify:fast runs every deterministic check in parallel; CI runs the same graph.
  • verify also runs the local full-history secret scan.
  • Live bootstrap checks inspect the active home directory. Run them only when the current machine should satisfy that profile.

Change the Owning Surface

  • Packages: Brewfile, Brewfile.developer, and Brewfile.<profile>.
  • Dotfiles: tracked source under chezmoi/.
  • Repo tasks: mise.toml; machine runtime pins: chezmoi/private_dot_config/mise/config.toml.tmpl.
  • Global agent setup: scripts/agents/; repository-local skills remain with their consumer.
  • Setup behavior: scripts/bootstrap/; verification and audit behavior: scripts/verify/ and scripts/audit/.

Read the matching guide from the documentation map before changing a contract. Keep one-machine preferences local or in a fork.

Pull Requests

  • Use Conventional Commits. Commit types drive the tag-only release policy in GitHub pipelines.
  • Keep pull requests focused and include the verification performed.
  • Update the owning guide when a command, path, profile, or security boundary changes.