Develop section and CONTRIBUTING.md #47

Closed
opened 2026-10-20 19:14:21 +00:00 by mintopia · 2 comments
Owner

What to build

Contributors can get from clone to a built app and a merged change using the Develop section: build from source, the recomp pipeline (modules, P-code via Ghidra, generation, emitter), dev tooling, testing, CI and releases, and repository structure. A root CONTRIBUTING.md covers gitflow, ADRs, comment policy, the no-game-files rule and the issue tracker, and is rendered on the site.

Acceptance criteria

  • Develop pages exist for each topic above
  • CONTRIBUTING.md at the root, shown on the site from that single file
  • Runnable race scenarios (scripts/) noted as documented once they exist

See ADR 0021 (docs site) and ADR 0022 (online service host).

## What to build Contributors can get from clone to a built app and a merged change using the Develop section: build from source, the recomp pipeline (modules, P-code via Ghidra, generation, emitter), dev tooling, testing, CI and releases, and repository structure. A root `CONTRIBUTING.md` covers gitflow, ADRs, comment policy, the no-game-files rule and the issue tracker, and is rendered on the site. ## Acceptance criteria - [ ] Develop pages exist for each topic above - [ ] CONTRIBUTING.md at the root, shown on the site from that single file - [ ] Runnable race scenarios (`scripts/`) noted as documented once they exist See ADR 0021 (docs site) and ADR 0022 (online service host).
mintopia added this to the Docs site milestone 2026-10-20 19:14:21 +00:00
Author
Owner

Added Develop pages: build-from-source, recomp-pipeline, dev-tooling, testing, repo-structure (CI/releases already existed as ci). Root CONTRIBUTING.md (gitflow, ADRs, comment policy, no-game-files, tracker) is published via symlink docs/contributing.md, single source. README links it. Race scenarios: noted in dev-tooling as documented once scripts/ exists. Site builds, links valid.

Added Develop pages: build-from-source, recomp-pipeline, dev-tooling, testing, repo-structure (CI/releases already existed as ci). Root CONTRIBUTING.md (gitflow, ADRs, comment policy, no-game-files, tracker) is published via symlink docs/contributing.md, single source. README links it. Race scenarios: noted in dev-tooling as documented once scripts/ exists. Site builds, links valid.
Author
Owner

Completed and merged by Harmonic (task 43).

Completed and merged by Harmonic (task 43).
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Reference
mintopia/blur#47
No description provided.