Skip to content

docs(docs): Give outside contributors a working setup and Quickstart - #12

Merged
WillieCubed merged 1 commit into
TheHypertextStudio:mainfrom
WillieCubed:claude/public-conformance
Nov 16, 2026
Merged

WillieCubed merged 1 commit into
TheHypertextStudio:mainfrom
WillieCubed:claude/public-conformance

Conversation

@WillieCubed

Copy link
Copy Markdown
Contributor

TL;DR

A fresh clone of this public repository now builds and tests without any Studio access. Setup decides by the effective Git committer email: an address at @hypertext.studio installs the commit hooks and pinned formatters as before, and any other address skips them and says so.

Changes

  • Adds scripts/setup.py, the single setup command. It creates .venv, installs the Python package and resolves the Swift dependencies for everyone. The commit hooks and pinned formatters download @thehypertextstudio/format-config from GitHub Packages, so only a Studio committer identity runs them. The contributor run lists each skipped step and what to do before pushing.
  • Adds tests/test_setup.py (unittest) covering the maintainer decision, the contributor path, the missing-identity case and a failing step.
  • Adds docs/DEVELOPMENT.md with the Quickstart and a Maintainers section, and points the README's formatting section at scripts/setup.py.
  • Adds the README License section linking LICENSE, and .github/CODEOWNERS (excluded from formatting in .hypertext/formatters.json).

Verified from a fresh clone with an empty HOME and no GitHub tokens: setup (contributor path), swift build, swift test, the 151 Python tests and scripts/build-release.py all pass. The Sparkle test needs OpenSSL 3 or newer because macOS's LibreSSL has no Ed25519, which the Quickstart states.

Follow-ups and Next Work

None.

🤖 Generated with Claude Code

Setup now decides by the effective Git committer email. An address at
@hypertext.studio keeps installing the commit hooks and pinned formatters,
which download a private package from GitHub Packages. Any other address
prepares the Python environment and Swift dependencies, skips those steps
and lists what it skipped, so a fresh clone builds and tests without Studio
access.

Adds the MIT License section to the README, CODEOWNERS and the development
Quickstart.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@WillieCubed
WillieCubed merged commit f1caac0 into TheHypertextStudio:main Nov 16, 2026
1 check failed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant