Repository navigation
docs(docs): Give outside contributors a working setup and Quickstart - #12
Merged
WillieCubed merged 1 commit intoNov 16, 2026
Merged
Conversation
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.studioinstalls the commit hooks and pinned formatters as before, and any other address skips them and says so.Changes
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-configfrom GitHub Packages, so only a Studio committer identity runs them. The contributor run lists each skipped step and what to do before pushing.tests/test_setup.py(unittest) covering the maintainer decision, the contributor path, the missing-identity case and a failing step.docs/DEVELOPMENT.mdwith the Quickstart and a Maintainers section, and points the README's formatting section atscripts/setup.py.LICENSE, and.github/CODEOWNERS(excluded from formatting in.hypertext/formatters.json).Verified from a fresh clone with an empty
HOMEand no GitHub tokens: setup (contributor path),swift build,swift test, the 151 Python tests andscripts/build-release.pyall 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