docs(p1): CONTRIBUTING.md four paths + README GIF placeholder#27
Conversation
…eholder Closes audit P1 acceptance criteria #11 (README GIF placeholder) and #12 (documentation covers all four contribution paths). CONTRIBUTING.md — first-class onboarding doc for new contributors: - Enumerates the four paths: Bridge (Python), TUI (Python/Textual), Unciv mod (JSON+Lua), Documentation (Markdown). Each with a clear files/entrypoint listing and "good for you if" hook. - Reproduces the test ownership matrix from PRD §"Test Ownership Matrix" and points at each path's test file. - PR process aligned with the project's safety rules (no force push to main, no --no-verify, branch naming convention). - Lists standing `good first issue`-style options per path so acceptance #13 has a path forward even before labeled issues exist. - Code style for each language (Python, Markdown, Lua, JSON). README.md — adds a GIF placeholder block at the top with the recording protocol pointer (`docs/media/README.md`). Acceptance criterion #11 calls out a *working* GIF; this lands the placeholder + recording spec so it can be filled in at M4 launch time when the Unciv map is authored. The placeholder is explicit, not deceptive — readers know it's a planned asset. docs/media/README.md — recording protocol for the V1 GIF: 30-second shot list, frame timing, ffmpeg + gifski pipeline. Documents WHY the GIF can't ship today (needs M4 map content first). No code changes. 191 tests still passing. Refs: CTO audit doc PR #22, kanban t_26404be3, acceptance #11 + #12. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a comprehensive CONTRIBUTING.md guide and documentation for media assets. The new contribution guide outlines development paths, testing requirements, and the pull request process. Additionally, a placeholder for a demonstration GIF has been added to the README.md, supported by a new docs/media/README.md file that details the recording protocol. Feedback was provided to clarify the mention of an internal kanban tool to avoid confusing external contributors.
| The kanban board (Hermes-managed at `http://127.0.0.1:9119/kanban` | ||
| locally) is internal coordination — external contributors interact | ||
| through GitHub Issues / PRs. |
There was a problem hiding this comment.
The reference to a local kanban board URL (http://127.0.0.1:9119/kanban) and the 'Hermes-managed' tool might be confusing for external contributors as it refers to an internal environment. If this tool is required for contribution, please provide instructions on how to set it up. Otherwise, consider moving this to a maintainer-specific section or clarifying that it is for core team use only.
1 participant
Closes audit P1 acceptance #11 (README GIF placeholder) + #12 (four contribution paths). 191 tests still passing. Refs PR #22, kanban t_26404be3.