메뉴
Synchronize technical sections in README.md and CONTRIBUTING.md with the actual project state.
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
SOC 직업 분류 기준
| name | sync-readme |
| description | Synchronize technical sections in README.md and CONTRIBUTING.md with the actual project state. |
| version | 1.0.0 |
Use this skill to keep the technical documentation (README.md and CONTRIBUTING.md) up-to-date with the codebase.
package.json.Analyze Project State: Directly observe the project to gather the necessary information:
packages/ and packages/plugins/ to see the monorepo structure.package.json to see available scripts.packages/cli/src/commands/ to identify commands and subcommands.Locate Sync Markers: Find the following markers in the documentation files:
<!-- SYNC:LAYOUT --> ... <!-- /SYNC:LAYOUT --><!-- SYNC:SCRIPTS --> ... <!-- /SYNC:SCRIPTS --><!-- SYNC:COMMANDS --> ... <!-- /SYNC:COMMANDS --><!-- SYNC:ARCHITECTURE --> ... <!-- /SYNC:ARCHITECTURE -->Update Content: Update the content between the markers based on your observations:
SYNC:LAYOUT (usually in CONTRIBUTING.md): List packages and their descriptions from their respective package.json files.SYNC:SCRIPTS (usually in CONTRIBUTING.md): Format scripts from the root package.json as a bulleted list.SYNC:COMMANDS (usually in README.md): Format CLI commands as markdown headings with bash examples.SYNC:ARCHITECTURE (usually in CONTRIBUTING.md): Review and update the Mermaid diagram if package relationships or key components have changed.Preserve Formatting: Ensure that you keep the markers themselves and only update the content between them. Use appropriate markdown blocks (code blocks, lists) that match the existing documentation style.
Consistently bump and synchronize versions across all packages in the monorepo using pnpm. Use this to ensure the root and all workspace packages share the same version number.
Run comprehensive integration tests using real skills (Vercel, Anthropic, Expo) in a Docker container. Managed via Makefile for standard lifecycle control.
Run linters and fix violations, formatting errors, or style mismatches using Trunk. Use when code quality checks fail, before submitting PRs, or to repair "broken" linting states.
Build the project and automatically fix any build errors, compilation failures, or type mismatches. Use when the project fails to build, shows "broken" states, or after making significant changes.
Perform a "hard reset" of the development environment. Use when dependencies are corrupted, lockfiles are out of sync, or environment tools (Trunk/pnpm) are in an inconsistent state.
Fix a GitHub issue end-to-end. Use when given an issue number to fix, implementing bug fixes, or addressing reported problems.