Table of contents
Getting set up to contribute
For a first code or documentation contribution. This is the merged main workflow, not the proposed CircleCI setup.
Start here
-
Read CONTRIBUTING.md, including the game-file and licensing rules. Search existing issues and pull requests before choosing one topic.
-
Clone from the forge:
git clone --depth 1 https://git.magicbean.dev/MagicBeanDev/Longshot.git cd Longshot -
Sign in from the repository folder:
python -I scripts/forge.py loginA person approves the browser sign-in. It covers the forge, team chat and test requests. It also sets up the
forgeremote and git's credential helper. See the forge guide. -
Follow development setup, then run the game-free checks:
python -I -B tests/run_all.pyA game build needs your own supported game copy. The checks do not need one. Record failures and skipped prerequisites honestly.
-
Read the existing claims and claim your work in
#dev-work. When ready to send a change, set up your fork:python -I scripts/forge.py forkWork on a branch and push to
forge-fork, never upstreamforge. Follow the branch and pull-request steps. -
Keep the pull request template intact. Use a Conventional Commit title. Fill in measurements at named commits, Testing, risks and the applicable checklist. Keep unfinished work WIP; mark it ready only when the requirements hold.
Labels and sign-in caveat
needs measurements identifies missing evidence. testing wanted requests testing and provides maintainer approval for a non-collaborator's request. It is not the proposed CircleCI ci: approved label. See test requests.
Issue 435 reports that signing in on a second machine can invalidate the first machine's OAuth renewal. Token sign-in is proposed there, not available in this main snapshot. Do not copy credentials between machines or assume repeated login fixes it.
Main currently runs light automatic checks, not the full game-free suite on every PR. The CircleCI proposal is separate.