Skip to content

Document branching/release workflow; update local setup to Altis#644

Open
svandragt wants to merge 5 commits into
mainfrom
docs/contributing-update
Open

Document branching/release workflow; update local setup to Altis#644
svandragt wants to merge 5 commits into
mainfrom
docs/contributing-update

Conversation

@svandragt

@svandragt svandragt commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

CONTRIBUTING didn't say anything about how releases are built, and that gap caught me out: I put a source fix straight into the release branch, which does nothing useful, because release is rebuilt by a GitHub Action on every push to main – merging into release skips the build, so the shipped bundle just stays stale.

So this adds a "Branching and releases" section that spells that out:

  • Work on main; branch off it, PR back into it.
  • Never commit to or PR against release – it's generated, and a hand-made commit there is overwritten by the next rebuild.
  • The Action resets release's source to main, builds, force-adds the gitignored build/, and force-pushes.
  • Consumers pin a release commit the Action produced, not a hand-made one.

While I was in there I also replaced the Chassis reference in local setup with Altis Local Server, which is what we actually use now. I left the @rmccue keys note and the Node 12 build reference alone, and I didn't document develop, since it's effectively main-only these days.

🤖 Generated with Claude Code

CONTRIBUTING didn't describe how releases are built, which led to source
changes being PR'd straight into the generated release branch (a no-op,
since the build Action only runs on main). Add a "Branching and releases"
section: work on main, never touch release, the Action builds and
force-pushes it, and consumers pin a release commit the Action produced.

Also replace the stale Chassis local-setup with Altis Local Server, which
is what we actually use now.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@svandragt svandragt self-assigned this Jun 1, 2026
@svandragt svandragt marked this pull request as ready for review June 1, 2026 14:41

@kadamwhite kadamwhite left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@svandragt Suggested some pieces that make it more comprehensible to me personally

Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
svandragt and others added 4 commits June 1, 2026 16:36
Co-authored-by: K Adam White <kadamwhite@users.noreply.github.com>
Co-authored-by: Joe Bailey-Roberts <33831317+Sephsekla@users.noreply.github.com>
Co-authored-by: K Adam White <kadamwhite@users.noreply.github.com>
Co-authored-by: Joe Bailey-Roberts <33831317+Sephsekla@users.noreply.github.com>
@svandragt svandragt requested review from Sephsekla and kadamwhite June 1, 2026 15:37
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.

3 participants