1.9 KiB
| description | alwaysApply |
|---|---|
| New Jira story = new branch from kickoff; doc-only on main when not story-scoped | true |
Git workflow (Neon Sprawl)
Agent: You may git commit at your discretion while on story/ticket work; do not git push. See commit-and-review.
-
Beginning work on a new Jira story — Create a new branch as soon as story work starts (planning, implementation, or both). Branch names must start with the Jira key (e.g.
NEON-3-position-state-api); see jira-git-naming. Stay on that branch for everything scoped to that issue, includingdocs/plans/{KEY}-implementation-plan.md, until the story is merged. Do not put ticketed story plans only onmainwhile implementation lives on a branch. -
Documentation-only work — Commit directly on
mainwhen the change is not tied to an active Jira story branch: general Markdown underdocs/(except per-story implementation plans for an issue you are working on that branch), root and nestedREADME.mdfiles,neon_sprawl_vision.plan.md, and other cross-cutting prose. No feature branch required. -
Code or implementation changes — Use a branch, then merge to
mainwhen ready. Commit subjects must start with the Jira key when the work maps to an issue (e.g.NEON-2: …). See jira-git-naming. This includes application source (C#, GDScript), Godot scenes and project files,docker-compose.yml,.csproj/ build config, CI workflows, JSON/YAML game data undercontent/, and JSON Schema when it ships with data pipelines—not standalone doc prose.
When a change mixes documentation and code, treat it as a code change (use a branch). Per-story implementation plans are part of the story branch, not an exception for main.
After the PR for a story branch is merged, clean up locally per story-end (checkout main, pull, branch -d).