Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
54 lines (37 loc) · 1.39 KB

CONTRIBUTING.md

File metadata and controls

54 lines (37 loc) · 1.39 KB

Contributing

Thanks for contributing to opencode-bootstrap.

Scope

This repository is focused on one thing: reproducible bootstrap of a curated global OpenCode setup for Linux, macOS, and WSL.

Please keep changes aligned with that goal.

Principles

  • Prefer minimal and reviewable diffs.
  • Keep the bootstrap flow idempotent.
  • Do not add secrets, tokens, or machine-specific credentials.
  • Keep MCP usage intentionally small.
  • Preserve Linux + macOS + WSL compatibility.

Before opening a PR

Run at least:

sh -n bootstrap.sh
sh -n scripts/verify.sh
sh -n scripts/generate-checksums.sh
./scripts/generate-checksums.sh --check
./bootstrap.sh --dry-run --target-dir /tmp/opencode-bootstrap-dry-run
./bootstrap.sh --target-dir /tmp/opencode-bootstrap-test --force --skip-backup
./scripts/verify.sh --target-dir /tmp/opencode-bootstrap-test

Then clean up temporary directories.

If you touch custom tools, also smoke-test tool loading through opencode serve and check that the expected tool IDs are present.

Bundle changes

If you change anything under bundle/:

  1. update the relevant files
  2. regenerate bundle/checksums.txt
  3. run the bootstrap smoke checks
  4. update CHANGELOG.md if the change is user-visible

Security

Do not commit:

  • ~/.local/share/opencode/auth.json
  • API keys
  • OAuth tokens
  • session exports containing secrets
  • machine-specific shell profile data