Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
241 lines (173 loc) · 10.7 KB

CONTRIBUTING.md

File metadata and controls

241 lines (173 loc) · 10.7 KB
Raw

Contributing to Asimov

Thanks for your interest in contributing! Asimov is a small, focused project and contributions of all sizes are welcome.

Getting started

Prerequisites: macOS with Homebrew installed.

git clone https://github.com/AsimovMac/asimov.git
cd asimov
brew install bats-core shellcheck

Verify everything works:

make check

Development workflow

Command What it does
make help List available make targets with descriptions
make test Run the Bats test suite
make test-system-bash Run the suite under the macOS system bash (3.2)
make lint Run ShellCheck on all shell scripts
make check Run both tests and linting
make version Print asimov version
make exclusions List all paths excluded from Time Machine (requires sudo)

To run a single test by name: bats tests/behavior.bats --filter "substring of test name" or bats tests/sentinels.bats --filter "npm".

Which bash your tests run under

asimov starts with #!/usr/bin/env bash, so it runs under whichever bash comes first on PATH. On macOS that is one of two very different things:

  • /bin/bash, the system bash, still 3.2 because Apple froze it at the last GPLv2 release. This is what most users get.
  • A 5.x build from Homebrew, which is probably what you get.

They disagree on array and IFS semantics, so a change can pass locally and fail for users. Before opening a PR touching shell logic, run:

make test-system-bash        # or: make test BASH_BIN=/bin/bash

CI runs the full matrix (both macOS versions × both bash versions) on every PR, so it will catch this either way, but the local target is faster than a round trip.

Tests can also run concurrently, which needs GNU parallel:

brew install parallel
make test BATS_JOBS=4

The main script supports --help, --version, --dry-run, --verbose, and --quiet; unknown options exit with an error.

Adding a new dependency pattern

This is the most common type of contribution, and it needs no bash: sentinels live in a data file.

  1. Add a row to data/sentinels.tsv — one per pattern, fields separated by a tab.
  2. Add a test in tests/sentinels.bats using create_project to build the fixture. Keep this file in sync with data/sentinels.tsv (one test per row).
  3. Run make check to verify your changes pass tests and linting.
  4. Add a changelog entry under the [Unreleased] section in CHANGELOG.md.

Example sentinel row (dir, sentinel, ecosystem, note):

.zig-cache	build.zig	zig	build cache

This means: exclude .zig-cache/ only when build.zig exists in the same directory. Glob metacharacters are allowed in the sentinel, e.g. DerivedData *.xcodeproj.

The same applies to global caches (data/fixed-dirs.tsv) and skipped directories (data/skip-paths.tsv). Paths in those two are relative to the home directory — write .npm/_cacache, not ~/.npm/_cacache.

Commit conventions

This project uses Conventional Commits. Format your commits as:

type(scope): short description

Types: feat, fix, docs, test, refactor, chore, build, ci

Examples:

  • feat(sentinels): add Zig build cache exclusion
  • fix: prevent duplicate exclusions on re-run
  • test: add coverage for Go modules
  • docs: update installation instructions

Pull requests

  • Branch from main (the default branch).
  • Keep PRs focused — one feature or fix per PR.
  • Ensure make check passes before submitting.
  • Update CHANGELOG.md for user-facing changes.

Code style

  • Bash/shell: 2-space indentation, LF line endings, UTF-8.
  • Enforced via EditorConfig — most editors pick this up automatically.

Project structure

bin/asimov              # Launcher: finds the library and data, then runs it
lib/asimov/
  bootstrap.sh          # Colours, constants, root and state-path resolution
  config.sh             # ~/.config/asimov/config
  data.sh               # Loaders for the data/ entities
  cache.sh              # ~/.cache/asimov state and the path cache
  scan.sh               # Which dirs to scan, and the find expression
  discover.sh           # Spotlight top-up on a cached run
  exclude.sh            # tmutil addexclusion, with its filters
  report.sh             # Usage, size formatting, run summary
  prune.sh              # The prune subcommand
  doctor.sh             # The doctor subcommand
  main.sh               # Argument parsing and dispatch
data/
  sentinels.tsv         # Directory + sentinel pairs
  fixed-dirs.tsv        # Global tool caches, always excluded
  skip-paths.tsv        # Directories never descended into
tests/
  sentinels.bats        # Tests for each dependency pattern
  behavior.bats         # Tests for edge cases and general behavior
  cache.bats            # Tests for the path cache
  doctor.bats           # Tests for the doctor subcommand
  format.bats           # Unit tests for format_size_kb()
  plist.bats            # Tests for the LaunchAgent plist
  test_helper.bash      # Shared setup/teardown and assertions
  bin/tmutil            # Mock tmutil for testing
  bin/mdfind            # Mock mdfind for testing
scripts/
  install.sh            # Local installation script
  install-remote.sh     # Curl-based remote installer
  uninstall.sh          # Uninstallation script
Makefile                # Build targets (test, lint, check, install, uninstall)

Installed, the three top-level pieces land under one prefix: <prefix>/bin/asimov, <prefix>/libexec/asimov/ and <prefix>/share/asimov/. The launcher resolves its own physical path (through symlinks, as Homebrew creates) and probes for both that layout and the repo layout, so ./bin/asimov works straight from a checkout. ASIMOV_LIB and ASIMOV_DATA override the probe.

Linting is whole-program. make lint runs shellcheck -x --source-path=. bin/asimov, which follows the source lines into every module. Running shellcheck on a module by itself reports false "unused variable" and "referenced but not assigned" warnings, because no single module is a complete program.

Releasing (maintainers)

The pipeline, end to end:

  1. Develop on a branch → PR into main. CI (macOS 14 + 15) must pass; commits must be signed.
  2. Merge to main.
  3. make release tags vX.Y.Z (signed) → GitHub Actions publishes the release + the asimov-X.Y.Z.tar.gz asset.
  4. Homebrew autobumps brew install asimov on its own (~3h later). Nothing to do.

Version = SemVer: new feature → minor, bug fix → patch. Pre-releases: make release-beta (GitHub pre-release; Homebrew ignores it). Details below.

main is protected: signed commits + PR required + both CI checks (test (macos-14), test (macos-15)) must pass. The flow below respects all of that.

One-time setup

Install signing keys (see SSH-signed commits below) in this clone — tags and commits must be signed.

Per-release flow

make prep-release VERSION=X.Y.Z              # branch, bump version, promote CHANGELOG, run check, commit
git push -u origin release/X.Y.Z
gh pr create --base main --fill --title "docs: release X.Y.Z"
gh pr checks <PR#> --watch --fail-fast

# After the PR is merged:
gh pr merge <PR#> --squash --delete-branch
git checkout main && git pull --ff-only

make release                                 # signed tag + push (Actions publishes the GitHub release)

Homebrew is homebrew-core, and it updates itself. asimov is on Homebrew's autobump list, so BrewTestBot opens the version-bump PR automatically (~3h after a GitHub release) — there is nothing to do for a normal version release. Attempting brew bump-formula-pr for a version will fail with an autobump-exclusion error.

Only metadata changes (homepage, url org, license) need a manual PR against homebrew-core — edit the formula, brew style Formula/a/asimov.rb, then open the PR. The old django23/homebrew-tap is archived and no longer used.

If gh pr create fails with Head sha can't be blank (GraphQL indexing lag), retry once or fall back to the REST API:

gh api repos/AsimovMac/asimov/pulls -X POST \
  -f title="docs: release X.Y.Z" \
  -f head="release/X.Y.Z" -f base="main" \
  -f body="See CHANGELOG.md"

Beta releases

Skip prep-release (no CHANGELOG promotion needed). Run make release-beta from any branch — it auto-increments the -beta.N suffix and marks the GitHub release as pre-release. Homebrew ignores pre-releases, so there's nothing else to do.

If something goes wrong

Tag already exists (duplicate from an earlier attempt). Delete remote tag + release, prune locally, re-run:

gh release delete vX.Y.Z --yes --cleanup-tag
git fetch --prune --prune-tags origin
git tag -d vX.Y.Z 2>/dev/null || true
make release                                  # re-tags from current main

CI fails on the release PR. Fix locally, push to the PR branch, re-run gh pr checks <PR#> --watch. Don't merge until green.

You merged the PR but make release aborts with "working tree not clean". Run git status — you likely have a stray local file. git stash it and retry.

make prep-release fails with "working tree not clean" but the dirty files ARE the release. prep-release assumes the version bump comes first and the substantive changes follow. If your work is already uncommitted, do it manually: branch (git checkout -b release/X.Y.Z), commit your changes, then bump ASIMOV_VERSION in asimov and run the awk block from scripts/prep-release.sh against CHANGELOG.md to promote [Unreleased] and add the compare links. Run make check, commit, push, open the PR.

SSH-signed commits (one-time per clone)

ssh-keygen -t ed25519 -f ~/.ssh/id_ed25519_signing -N ""
gh auth refresh -s admin:ssh_signing_key
gh ssh-key add ~/.ssh/id_ed25519_signing.pub --type signing --title "$(hostname)"

git config user.email "$(gh api user --jq '.id')+$(gh api user --jq '.login')@users.noreply.github.com"
git config gpg.format ssh
git config user.signingkey ~/.ssh/id_ed25519_signing.pub
git config commit.gpgsign true
git config tag.gpgsign true

mkdir -p ~/.config/git
echo "$(git config user.email) $(awk '{print $1, $2}' ~/.ssh/id_ed25519_signing.pub)" >> ~/.config/git/allowed_signers
git config gpg.ssh.allowedSignersFile ~/.config/git/allowed_signers

Questions?

Open an issue — happy to help.