GitHub Workflow¶
This repository follows a staging to main delivery model with GitHub-managed
reviews, CI, and release promotion.
Delivery loop¶
- start from
staging - create a short-lived branch
- implement changes
- run local verification
- open a pull request to
staging - collect review and local verification evidence
- merge to
stagingafter approval - let GitHub Actions validate docs and code on the resulting
stagingpush - use
Closes #123keywords in the staging PR for stories that are truly complete in that branch - let the push-driven promotion workflow open or refresh the
stagingtomainproduction PR - approve and merge the release PR to complete the production promotion
- publish docs from
main, deploy Firebase production changes, create the GitHub release, upload the Android AAB plus signed iOS IPA, publish the mobile and Firebase images, and close released stories and epics
Pull request checklist¶
- explain scope clearly
- link the related story with a closing keyword such as
Closes #123 - note testing performed
- call out schema or contract changes
- include screenshots when UI content changes
Repository scaffolding¶
The GitHub setup includes:
- issue templates for epic, story, docs, bug, and technical task intake
- a pull request template
- CODEOWNERS for review routing
- labels for epics, stories, domains, and agent-driven work
- a backlog bootstrap script that creates GitHub issues from the source planning doc
- a production Firebase deployment workflow that reads credentials from the
productionenvironment - a production release workflow that cuts semver tags, writes friendly notes, uploads the Android AAB plus signed iOS IPA, and publishes the mobile and Firebase images
Backlog source of truth¶
Planning starts from:
AI_BUILD_MASTER_DOC.mdAI_AGENT_TASKS_150_ISSUES.mdGITHUB_AUTOMATION_AI_PIPELINE.md
Use scripts/bootstrap_github_backlog.py to project those planning artifacts into
GitHub issues without losing the original markdown source.