moai-adk 0.11.0__py3-none-any.whl → 0.11.1__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of moai-adk might be problematic. Click here for more details.
- moai_adk/core/issue_creator.py +2 -2
- moai_adk/core/project/detector.py +285 -12
- moai_adk/templates/.claude/agents/alfred/cc-manager.md +316 -0
- moai_adk/templates/.claude/agents/alfred/debug-helper.md +208 -0
- moai_adk/templates/.claude/agents/alfred/doc-syncer.md +214 -0
- moai_adk/templates/.claude/agents/alfred/git-manager.md +406 -0
- moai_adk/templates/.claude/agents/alfred/implementation-planner.md +350 -0
- moai_adk/templates/.claude/agents/alfred/project-manager.md +273 -0
- moai_adk/templates/.claude/agents/alfred/quality-gate.md +343 -0
- moai_adk/templates/.claude/agents/alfred/skill-factory.md +865 -0
- moai_adk/templates/.claude/agents/alfred/spec-builder.md +287 -0
- moai_adk/templates/.claude/agents/alfred/tag-agent.md +287 -0
- moai_adk/templates/.claude/agents/alfred/tdd-implementer.md +326 -0
- moai_adk/templates/.claude/agents/alfred/trust-checker.md +375 -0
- moai_adk/templates/.claude/commands/alfred/0-project.md +1187 -0
- moai_adk/templates/.claude/commands/alfred/1-plan.md +734 -0
- moai_adk/templates/.claude/commands/alfred/2-run.md +551 -0
- moai_adk/templates/.claude/commands/alfred/3-sync.md +689 -0
- moai_adk/templates/.claude/commands/alfred/9-feedback.md +149 -0
- moai_adk/templates/.claude/hooks/alfred/alfred_hooks.py +208 -0
- moai_adk/templates/.claude/hooks/alfred/core/project.py +744 -0
- moai_adk/templates/.claude/hooks/alfred/core/timeout.py +136 -0
- moai_adk/templates/.claude/hooks/alfred/core/ttl_cache.py +109 -0
- moai_adk/templates/.claude/hooks/alfred/core/version_cache.py +198 -0
- moai_adk/templates/.claude/hooks/alfred/notification__handle_events.py +97 -0
- moai_adk/templates/.claude/hooks/alfred/post_tool__log_changes.py +97 -0
- moai_adk/templates/.claude/hooks/alfred/pre_tool__auto_checkpoint.py +103 -0
- moai_adk/templates/.claude/hooks/alfred/session_end__cleanup.py +97 -0
- moai_adk/templates/.claude/hooks/alfred/session_start__show_project_info.py +97 -0
- moai_adk/templates/.claude/hooks/alfred/shared/core/__init__.py +170 -0
- moai_adk/templates/.claude/hooks/alfred/shared/core/checkpoint.py +271 -0
- moai_adk/templates/.claude/hooks/alfred/shared/core/context.py +67 -0
- moai_adk/templates/.claude/hooks/alfred/shared/core/project.py +749 -0
- moai_adk/templates/.claude/hooks/alfred/shared/core/tags.py +230 -0
- moai_adk/templates/.claude/hooks/alfred/shared/core/version_cache.py +198 -0
- moai_adk/templates/.claude/hooks/alfred/shared/handlers/__init__.py +21 -0
- moai_adk/templates/.claude/hooks/alfred/shared/handlers/notification.py +156 -0
- moai_adk/templates/.claude/hooks/alfred/shared/handlers/session.py +174 -0
- moai_adk/templates/.claude/hooks/alfred/shared/handlers/tool.py +87 -0
- moai_adk/templates/.claude/hooks/alfred/shared/handlers/user.py +61 -0
- moai_adk/templates/.claude/hooks/alfred/stop__handle_interrupt.py +97 -0
- moai_adk/templates/.claude/hooks/alfred/subagent_stop__handle_subagent_end.py +97 -0
- moai_adk/templates/.claude/hooks/alfred/user_prompt__jit_load_docs.py +111 -0
- moai_adk/templates/.claude/hooks/alfred/utils/__init__.py +1 -0
- moai_adk/templates/.claude/hooks/alfred/utils/timeout.py +136 -0
- moai_adk/templates/.claude/output-styles/alfred/agentic-coding.md +640 -0
- moai_adk/templates/.claude/output-styles/alfred/moai-adk-learning.md +696 -0
- moai_adk/templates/.claude/output-styles/alfred/study-with-alfred.md +474 -0
- moai_adk/templates/.claude/settings.json +144 -0
- moai_adk/templates/.claude/skills/moai-alfred-ears-authoring/SKILL.md +113 -0
- moai_adk/templates/.claude/skills/moai-alfred-ears-authoring/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-alfred-ears-authoring/reference.md +28 -0
- moai_adk/templates/.claude/skills/moai-alfred-git-workflow/SKILL.md +122 -0
- moai_adk/templates/.claude/skills/moai-alfred-git-workflow/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-alfred-git-workflow/reference.md +29 -0
- moai_adk/templates/.claude/skills/moai-alfred-interactive-questions/SKILL.md +237 -0
- moai_adk/templates/.claude/skills/moai-alfred-interactive-questions/examples.md +615 -0
- moai_adk/templates/.claude/skills/moai-alfred-interactive-questions/reference.md +653 -0
- moai_adk/templates/.claude/skills/moai-alfred-language-detection/SKILL.md +113 -0
- moai_adk/templates/.claude/skills/moai-alfred-language-detection/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-alfred-language-detection/reference.md +28 -0
- moai_adk/templates/.claude/skills/moai-alfred-spec-metadata-validation/SKILL.md +113 -0
- moai_adk/templates/.claude/skills/moai-alfred-spec-metadata-validation/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-alfred-spec-metadata-validation/reference.md +28 -0
- moai_adk/templates/.claude/skills/moai-alfred-tag-scanning/SKILL.md +113 -0
- moai_adk/templates/.claude/skills/moai-alfred-tag-scanning/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-alfred-tag-scanning/reference.md +28 -0
- moai_adk/templates/.claude/skills/moai-alfred-trust-validation/SKILL.md +113 -0
- moai_adk/templates/.claude/skills/moai-alfred-trust-validation/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-alfred-trust-validation/reference.md +28 -0
- moai_adk/templates/.claude/skills/moai-cc-agents/SKILL.md +269 -0
- moai_adk/templates/.claude/skills/moai-cc-agents/templates/agent-template.md +32 -0
- moai_adk/templates/.claude/skills/moai-cc-claude-md/SKILL.md +298 -0
- moai_adk/templates/.claude/skills/moai-cc-claude-md/templates/CLAUDE-template.md +26 -0
- moai_adk/templates/.claude/skills/moai-cc-commands/SKILL.md +307 -0
- moai_adk/templates/.claude/skills/moai-cc-commands/templates/command-template.md +21 -0
- moai_adk/templates/.claude/skills/moai-cc-hooks/SKILL.md +252 -0
- moai_adk/templates/.claude/skills/moai-cc-hooks/scripts/pre-bash-check.sh +19 -0
- moai_adk/templates/.claude/skills/moai-cc-hooks/scripts/preserve-permissions.sh +19 -0
- moai_adk/templates/.claude/skills/moai-cc-hooks/scripts/validate-bash-command.py +24 -0
- moai_adk/templates/.claude/skills/moai-cc-mcp-plugins/SKILL.md +199 -0
- moai_adk/templates/.claude/skills/moai-cc-mcp-plugins/templates/settings-mcp-template.json +39 -0
- moai_adk/templates/.claude/skills/moai-cc-memory/SKILL.md +316 -0
- moai_adk/templates/.claude/skills/moai-cc-memory/templates/session-summary-template.md +18 -0
- moai_adk/templates/.claude/skills/moai-cc-settings/SKILL.md +263 -0
- moai_adk/templates/.claude/skills/moai-cc-settings/templates/settings-complete-template.json +30 -0
- moai_adk/templates/.claude/skills/moai-cc-skills/SKILL.md +291 -0
- moai_adk/templates/.claude/skills/moai-cc-skills/templates/SKILL-template.md +15 -0
- moai_adk/templates/.claude/skills/moai-domain-backend/SKILL.md +290 -0
- moai_adk/templates/.claude/skills/moai-domain-backend/examples.md +1633 -0
- moai_adk/templates/.claude/skills/moai-domain-backend/reference.md +660 -0
- moai_adk/templates/.claude/skills/moai-domain-cli-tool/SKILL.md +123 -0
- moai_adk/templates/.claude/skills/moai-domain-cli-tool/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-domain-cli-tool/reference.md +30 -0
- moai_adk/templates/.claude/skills/moai-domain-data-science/SKILL.md +123 -0
- moai_adk/templates/.claude/skills/moai-domain-data-science/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-domain-data-science/reference.md +30 -0
- moai_adk/templates/.claude/skills/moai-domain-database/SKILL.md +123 -0
- moai_adk/templates/.claude/skills/moai-domain-database/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-domain-database/reference.md +30 -0
- moai_adk/templates/.claude/skills/moai-domain-devops/SKILL.md +124 -0
- moai_adk/templates/.claude/skills/moai-domain-devops/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-domain-devops/reference.md +31 -0
- moai_adk/templates/.claude/skills/moai-domain-frontend/SKILL.md +124 -0
- moai_adk/templates/.claude/skills/moai-domain-frontend/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-domain-frontend/reference.md +31 -0
- moai_adk/templates/.claude/skills/moai-domain-ml/SKILL.md +123 -0
- moai_adk/templates/.claude/skills/moai-domain-ml/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-domain-ml/reference.md +30 -0
- moai_adk/templates/.claude/skills/moai-domain-mobile-app/SKILL.md +123 -0
- moai_adk/templates/.claude/skills/moai-domain-mobile-app/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-domain-mobile-app/reference.md +30 -0
- moai_adk/templates/.claude/skills/moai-domain-security/SKILL.md +123 -0
- moai_adk/templates/.claude/skills/moai-domain-security/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-domain-security/reference.md +30 -0
- moai_adk/templates/.claude/skills/moai-domain-web-api/SKILL.md +123 -0
- moai_adk/templates/.claude/skills/moai-domain-web-api/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-domain-web-api/reference.md +30 -0
- moai_adk/templates/.claude/skills/moai-essentials-debug/SKILL.md +303 -0
- moai_adk/templates/.claude/skills/moai-essentials-debug/examples.md +1064 -0
- moai_adk/templates/.claude/skills/moai-essentials-debug/reference.md +1047 -0
- moai_adk/templates/.claude/skills/moai-essentials-perf/SKILL.md +113 -0
- moai_adk/templates/.claude/skills/moai-essentials-perf/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-essentials-perf/reference.md +28 -0
- moai_adk/templates/.claude/skills/moai-essentials-refactor/SKILL.md +113 -0
- moai_adk/templates/.claude/skills/moai-essentials-refactor/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-essentials-refactor/reference.md +28 -0
- moai_adk/templates/.claude/skills/moai-essentials-review/SKILL.md +113 -0
- moai_adk/templates/.claude/skills/moai-essentials-review/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-essentials-review/reference.md +28 -0
- moai_adk/templates/.claude/skills/moai-foundation-ears/SKILL.md +116 -0
- moai_adk/templates/.claude/skills/moai-foundation-ears/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-foundation-ears/reference.md +28 -0
- moai_adk/templates/.claude/skills/moai-foundation-git/SKILL.md +122 -0
- moai_adk/templates/.claude/skills/moai-foundation-git/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-foundation-git/reference.md +29 -0
- moai_adk/templates/.claude/skills/moai-foundation-langs/SKILL.md +113 -0
- moai_adk/templates/.claude/skills/moai-foundation-langs/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-foundation-langs/reference.md +28 -0
- moai_adk/templates/.claude/skills/moai-foundation-specs/SKILL.md +113 -0
- moai_adk/templates/.claude/skills/moai-foundation-specs/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-foundation-specs/reference.md +28 -0
- moai_adk/templates/.claude/skills/moai-foundation-tags/SKILL.md +113 -0
- moai_adk/templates/.claude/skills/moai-foundation-tags/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-foundation-tags/reference.md +28 -0
- moai_adk/templates/.claude/skills/moai-foundation-trust/SKILL.md +307 -0
- moai_adk/templates/.claude/skills/moai-foundation-trust/examples.md +0 -0
- moai_adk/templates/.claude/skills/moai-foundation-trust/reference.md +1099 -0
- moai_adk/templates/.claude/skills/moai-lang-c/SKILL.md +124 -0
- moai_adk/templates/.claude/skills/moai-lang-c/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-lang-c/reference.md +31 -0
- moai_adk/templates/.claude/skills/moai-lang-cpp/SKILL.md +124 -0
- moai_adk/templates/.claude/skills/moai-lang-cpp/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-lang-cpp/reference.md +31 -0
- moai_adk/templates/.claude/skills/moai-lang-csharp/SKILL.md +123 -0
- moai_adk/templates/.claude/skills/moai-lang-csharp/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-lang-csharp/reference.md +30 -0
- moai_adk/templates/.claude/skills/moai-lang-dart/SKILL.md +123 -0
- moai_adk/templates/.claude/skills/moai-lang-dart/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-lang-dart/reference.md +30 -0
- moai_adk/templates/.claude/skills/moai-lang-go/SKILL.md +124 -0
- moai_adk/templates/.claude/skills/moai-lang-go/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-lang-go/reference.md +31 -0
- moai_adk/templates/.claude/skills/moai-lang-java/SKILL.md +124 -0
- moai_adk/templates/.claude/skills/moai-lang-java/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-lang-java/reference.md +31 -0
- moai_adk/templates/.claude/skills/moai-lang-javascript/SKILL.md +125 -0
- moai_adk/templates/.claude/skills/moai-lang-javascript/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-lang-javascript/reference.md +32 -0
- moai_adk/templates/.claude/skills/moai-lang-kotlin/SKILL.md +124 -0
- moai_adk/templates/.claude/skills/moai-lang-kotlin/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-lang-kotlin/reference.md +31 -0
- moai_adk/templates/.claude/skills/moai-lang-php/SKILL.md +123 -0
- moai_adk/templates/.claude/skills/moai-lang-php/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-lang-php/reference.md +30 -0
- moai_adk/templates/.claude/skills/moai-lang-python/SKILL.md +431 -0
- moai_adk/templates/.claude/skills/moai-lang-python/examples.md +624 -0
- moai_adk/templates/.claude/skills/moai-lang-python/reference.md +316 -0
- moai_adk/templates/.claude/skills/moai-lang-r/SKILL.md +123 -0
- moai_adk/templates/.claude/skills/moai-lang-r/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-lang-r/reference.md +30 -0
- moai_adk/templates/.claude/skills/moai-lang-ruby/SKILL.md +124 -0
- moai_adk/templates/.claude/skills/moai-lang-ruby/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-lang-ruby/reference.md +31 -0
- moai_adk/templates/.claude/skills/moai-lang-rust/SKILL.md +124 -0
- moai_adk/templates/.claude/skills/moai-lang-rust/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-lang-rust/reference.md +31 -0
- moai_adk/templates/.claude/skills/moai-lang-scala/SKILL.md +123 -0
- moai_adk/templates/.claude/skills/moai-lang-scala/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-lang-scala/reference.md +30 -0
- moai_adk/templates/.claude/skills/moai-lang-shell/SKILL.md +123 -0
- moai_adk/templates/.claude/skills/moai-lang-shell/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-lang-shell/reference.md +30 -0
- moai_adk/templates/.claude/skills/moai-lang-sql/SKILL.md +124 -0
- moai_adk/templates/.claude/skills/moai-lang-sql/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-lang-sql/reference.md +31 -0
- moai_adk/templates/.claude/skills/moai-lang-swift/SKILL.md +123 -0
- moai_adk/templates/.claude/skills/moai-lang-swift/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-lang-swift/reference.md +30 -0
- moai_adk/templates/.claude/skills/moai-lang-typescript/SKILL.md +127 -0
- moai_adk/templates/.claude/skills/moai-lang-typescript/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-lang-typescript/reference.md +34 -0
- moai_adk/templates/.claude/skills/moai-skill-factory/CHECKLIST.md +482 -0
- moai_adk/templates/.claude/skills/moai-skill-factory/EXAMPLES.md +278 -0
- moai_adk/templates/.claude/skills/moai-skill-factory/INTERACTIVE-DISCOVERY.md +524 -0
- moai_adk/templates/.claude/skills/moai-skill-factory/METADATA.md +477 -0
- moai_adk/templates/.claude/skills/moai-skill-factory/PARALLEL-ANALYSIS-REPORT.md +429 -0
- moai_adk/templates/.claude/skills/moai-skill-factory/PYTHON-VERSION-MATRIX.md +391 -0
- moai_adk/templates/.claude/skills/moai-skill-factory/SKILL-FACTORY-WORKFLOW.md +431 -0
- moai_adk/templates/.claude/skills/moai-skill-factory/SKILL-UPDATE-ADVISOR.md +577 -0
- moai_adk/templates/.claude/skills/moai-skill-factory/SKILL.md +271 -0
- moai_adk/templates/.claude/skills/moai-skill-factory/STEP-BY-STEP-GUIDE.md +466 -0
- moai_adk/templates/.claude/skills/moai-skill-factory/STRUCTURE.md +583 -0
- moai_adk/templates/.claude/skills/moai-skill-factory/WEB-RESEARCH.md +526 -0
- moai_adk/templates/.claude/skills/moai-skill-factory/reference.md +465 -0
- moai_adk/templates/.claude/skills/moai-skill-factory/scripts/generate-structure.sh +328 -0
- moai_adk/templates/.claude/skills/moai-skill-factory/scripts/validate-skill.sh +312 -0
- moai_adk/templates/.claude/skills/moai-skill-factory/templates/SKILL_TEMPLATE.md +245 -0
- moai_adk/templates/.claude/skills/moai-skill-factory/templates/examples-template.md +285 -0
- moai_adk/templates/.claude/skills/moai-skill-factory/templates/reference-template.md +278 -0
- moai_adk/templates/.claude/skills/moai-skill-factory/templates/scripts-template.sh +303 -0
- moai_adk/templates/.claude/skills/moai-spec-authoring/README.md +137 -0
- moai_adk/templates/.claude/skills/moai-spec-authoring/SKILL.md +219 -0
- moai_adk/templates/.claude/skills/moai-spec-authoring/examples/validate-spec.sh +161 -0
- moai_adk/templates/.claude/skills/moai-spec-authoring/examples.md +541 -0
- moai_adk/templates/.claude/skills/moai-spec-authoring/reference.md +622 -0
- moai_adk/templates/.github/workflows/c-tag-validation.yml +83 -0
- moai_adk/templates/.github/workflows/cpp-tag-validation.yml +79 -0
- moai_adk/templates/.github/workflows/csharp-tag-validation.yml +65 -0
- moai_adk/templates/.github/workflows/dart-tag-validation.yml +82 -0
- moai_adk/templates/.github/workflows/java-tag-validation.yml +75 -0
- moai_adk/templates/.github/workflows/kotlin-tag-validation.yml +67 -0
- moai_adk/templates/.github/workflows/php-tag-validation.yml +56 -0
- moai_adk/templates/.github/workflows/ruby-tag-validation.yml +68 -0
- moai_adk/templates/.github/workflows/rust-tag-validation.yml +73 -0
- moai_adk/templates/.github/workflows/shell-tag-validation.yml +65 -0
- moai_adk/templates/.github/workflows/swift-tag-validation.yml +79 -0
- moai_adk/templates/.moai/config.json +113 -0
- moai_adk/templates/.moai/memory/CLAUDE-AGENTS-GUIDE.md +208 -0
- moai_adk/templates/.moai/memory/CLAUDE-PRACTICES.md +369 -0
- moai_adk/templates/.moai/memory/CLAUDE-RULES.md +539 -0
- moai_adk/templates/.moai/memory/DEVELOPMENT-GUIDE.md +344 -0
- moai_adk/templates/.moai/memory/GITFLOW-PROTECTION-POLICY.md +330 -0
- moai_adk/templates/.moai/memory/ISSUE-LABEL-MAPPING.md +150 -0
- moai_adk/templates/.moai/memory/SKILLS-DESCRIPTION-POLICY.md +218 -0
- moai_adk/templates/.moai/memory/SPEC-METADATA.md +356 -0
- moai_adk/templates/.moai/memory/gitflow-protection-policy.md +330 -0
- moai_adk/templates/.moai/memory/spec-metadata.md +356 -0
- moai_adk/templates/.moai/project/product.md +161 -0
- moai_adk/templates/.moai/project/structure.md +156 -0
- moai_adk/templates/.moai/project/tech.md +227 -0
- moai_adk/templates/CLAUDE.md +90 -10
- moai_adk/templates/workflows/go-tag-validation.yml +130 -0
- moai_adk/templates/workflows/javascript-tag-validation.yml +135 -0
- moai_adk/templates/workflows/python-tag-validation.yml +118 -0
- moai_adk/templates/workflows/typescript-tag-validation.yml +154 -0
- {moai_adk-0.11.0.dist-info → moai_adk-0.11.1.dist-info}/METADATA +43 -1
- moai_adk-0.11.1.dist-info/RECORD +330 -0
- moai_adk-0.11.0.dist-info/RECORD +0 -77
- /moai_adk/templates/.github/workflows/{release.yml → moai-adk-release.yml} +0 -0
- /moai_adk/templates/.github/workflows/{spec-issue-sync.yml → moai-adk-spec-issue-sync.yml} +0 -0
- /moai_adk/templates/.github/workflows/{tag-validation.yml → moai-adk-tag-validation.yml} +0 -0
- {moai_adk-0.11.0.dist-info → moai_adk-0.11.1.dist-info}/WHEEL +0 -0
- {moai_adk-0.11.0.dist-info → moai_adk-0.11.1.dist-info}/entry_points.txt +0 -0
- {moai_adk-0.11.0.dist-info → moai_adk-0.11.1.dist-info}/licenses/LICENSE +0 -0
|
@@ -0,0 +1,344 @@
|
|
|
1
|
+
# {{PROJECT_NAME}} Development Guide
|
|
2
|
+
|
|
3
|
+
> "No spec, no code. No tests, no implementation."
|
|
4
|
+
|
|
5
|
+
This unified guardrail applies to every agent and developer who uses the MoAI-ADK universal development toolkit. The Python-based toolkit supports all major programming languages and enforces a SPEC-first TDD methodology with @TAG traceability. English is the default working language.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## SPEC-First TDD Workflow
|
|
10
|
+
|
|
11
|
+
### Core Development Loop (3 Steps)
|
|
12
|
+
|
|
13
|
+
1. **Write the SPEC** (`/alfred:1-plan`) → no code without a spec
|
|
14
|
+
2. **Implement with TDD** (`/alfred:2-run`) → no implementation without tests
|
|
15
|
+
3. **Sync Documentation** (`/alfred:3-sync`) → no completion without traceability
|
|
16
|
+
|
|
17
|
+
### On-Demand Support
|
|
18
|
+
|
|
19
|
+
- **Debugging**: summon `@agent-debug-helper` when failures occur
|
|
20
|
+
- **CLI Commands**: init, doctor, status, update, restore, help, version
|
|
21
|
+
- **System Diagnostics**: auto-detect language tooling and verify prerequisites
|
|
22
|
+
|
|
23
|
+
Every change must comply with the @TAG system, SPEC-derived requirements, and language-specific TDD practices.
|
|
24
|
+
|
|
25
|
+
### EARS Requirement Authoring
|
|
26
|
+
|
|
27
|
+
**EARS (Easy Approach to Requirements Syntax)** provides a disciplined method for writing requirements.
|
|
28
|
+
|
|
29
|
+
#### Five EARS Patterns
|
|
30
|
+
1. **Ubiquitous Requirements**: The system shall provide [capability].
|
|
31
|
+
2. **Event-driven Requirements**: WHEN [condition], the system shall [behaviour].
|
|
32
|
+
3. **State-driven Requirements**: WHILE [state], the system shall [behaviour].
|
|
33
|
+
4. **Optional Features**: WHERE [condition], the system may [behaviour].
|
|
34
|
+
5. **Constraints**: IF [condition], the system shall enforce [constraint].
|
|
35
|
+
|
|
36
|
+
#### Practical Example
|
|
37
|
+
```markdown
|
|
38
|
+
### Ubiquitous Requirements (Baseline)
|
|
39
|
+
- The system shall provide user authentication.
|
|
40
|
+
|
|
41
|
+
### Event-driven Requirements
|
|
42
|
+
- WHEN a user logs in with valid credentials, the system shall issue a JWT token.
|
|
43
|
+
- WHEN a token expires, the system shall return a 401 error.
|
|
44
|
+
|
|
45
|
+
### State-driven Requirements
|
|
46
|
+
- WHILE the user remains authenticated, the system shall allow access to protected resources.
|
|
47
|
+
|
|
48
|
+
### Optional Features
|
|
49
|
+
- WHERE a refresh token is present, the system may issue a new access token.
|
|
50
|
+
|
|
51
|
+
### Constraints
|
|
52
|
+
- IF an invalid token is supplied, the system shall deny access.
|
|
53
|
+
- Access tokens shall not exceed a 15-minute lifetime.
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
---
|
|
57
|
+
|
|
58
|
+
## Context Engineering
|
|
59
|
+
|
|
60
|
+
MoAI-ADK follows Anthropic's principles from “Effective Context Engineering for AI Agents” to keep context lean and relevant.
|
|
61
|
+
|
|
62
|
+
### 1. JIT (Just-in-Time) Retrieval
|
|
63
|
+
|
|
64
|
+
**Principle**: Load documents only when needed to minimize initial context load.
|
|
65
|
+
|
|
66
|
+
**Alfred’s JIT Strategy**:
|
|
67
|
+
|
|
68
|
+
| Command | Required Load | Optional Load | Timing |
|
|
69
|
+
| ---------------- | ---------------- | -------------------------------- | ---------------------------------- |
|
|
70
|
+
| `/alfred:1-plan` | product.md | structure.md, tech.md | While discovering SPEC candidates |
|
|
71
|
+
| `/alfred:2-run` | SPEC-XXX/spec.md | development-guide.md | At the start of TDD implementation |
|
|
72
|
+
| `/alfred:3-sync` | sync-report.md | TAG chain validation (`rg` scan) | During documentation sync |
|
|
73
|
+
|
|
74
|
+
**Implementation Notes**:
|
|
75
|
+
- Alfred uses the `Read` tool to load only the necessary documents at command time.
|
|
76
|
+
- Agents request only the documents relevant to their current task.
|
|
77
|
+
- The five documents listed in CLAUDE.md “Memory Strategy” are always loaded.
|
|
78
|
+
|
|
79
|
+
### Context Engineering Checklist
|
|
80
|
+
|
|
81
|
+
**When designing commands**:
|
|
82
|
+
- [ ] JIT: Do we load only the required documents?
|
|
83
|
+
- [ ] Optional Load: Do we load documents conditionally?
|
|
84
|
+
|
|
85
|
+
**When designing agents**:
|
|
86
|
+
- [ ] Minimum tools: Does the YAML frontmatter declare only the needed tools?
|
|
87
|
+
- [ ] Clear roles: Does each agent maintain a single responsibility?
|
|
88
|
+
|
|
89
|
+
---
|
|
90
|
+
|
|
91
|
+
## TRUST Principles (5 Pillars)
|
|
92
|
+
|
|
93
|
+
### T – Test-Driven Development (SPEC-Aligned)
|
|
94
|
+
|
|
95
|
+
**SPEC → Test → Code Cycle**:
|
|
96
|
+
|
|
97
|
+
- **SPEC**: Author detailed specifications first with `@SPEC:ID` tags (EARS format).
|
|
98
|
+
- **RED**: `@TEST:ID` – write failing tests tied to SPEC requirements and confirm failure.
|
|
99
|
+
- **GREEN**: `@CODE:ID` – implement the minimal code that passes the tests and satisfies the SPEC.
|
|
100
|
+
- **REFACTOR**: `@CODE:ID` – improve the code while preserving SPEC compliance, then document with `@DOC:ID`.
|
|
101
|
+
|
|
102
|
+
**Language-Specific TDD Tooling**:
|
|
103
|
+
|
|
104
|
+
- **Python**: pytest + SPEC-based test cases (with mypy type hints)
|
|
105
|
+
- **TypeScript**: Vitest + SPEC-driven suites (strict typing)
|
|
106
|
+
- **Java**: JUnit + SPEC annotations (behaviour-driven tests)
|
|
107
|
+
- **Go**: go test + SPEC table-driven tests (interface adherence)
|
|
108
|
+
- **Rust**: cargo test + SPEC doc tests (trait validation)
|
|
109
|
+
- **Ruby**: RSpec + SPEC-based BDD scenarios
|
|
110
|
+
|
|
111
|
+
Each test links SPEC requirements to implementations via `@TEST:ID → @CODE:ID`.
|
|
112
|
+
|
|
113
|
+
### R – Requirement-Driven Readability
|
|
114
|
+
|
|
115
|
+
**SPEC-Aligned Clean Code**:
|
|
116
|
+
|
|
117
|
+
- Functions implement SPEC requirements directly (≤ 50 LOC per function).
|
|
118
|
+
- Names mirror SPEC terminology and domain language.
|
|
119
|
+
- Code structure reflects SPEC design decisions.
|
|
120
|
+
- Comments are limited to SPEC clarifications and @TAG references.
|
|
121
|
+
|
|
122
|
+
**Language-Specific SPEC Implementation**:
|
|
123
|
+
|
|
124
|
+
- **Python**: Type hints mirroring SPEC interfaces + mypy validation
|
|
125
|
+
- **TypeScript**: Strict interfaces that match SPEC contracts
|
|
126
|
+
- **Java**: Classes implementing SPEC components with strong typing
|
|
127
|
+
- **Go**: Interfaces that satisfy SPEC requirements + gofmt
|
|
128
|
+
- **Rust**: Types enforcing SPEC safety requirements + rustfmt
|
|
129
|
+
- **Ruby**: Behaviour reflecting SPEC narratives + RuboCop validation
|
|
130
|
+
|
|
131
|
+
Every code element must remain traceable back to the SPEC via @TAG comments.
|
|
132
|
+
|
|
133
|
+
### U – Unified SPEC Architecture
|
|
134
|
+
|
|
135
|
+
- **SPEC-Driven Complexity**: Each SPEC defines its complexity threshold. Exceeding it requires a new SPEC or a documented exception.
|
|
136
|
+
- **SPEC vs. Implementation**: Keep authoring and implementation separate; never edit the SPEC mid-TDD cycle.
|
|
137
|
+
- **Language Boundaries**: SPECs define boundaries across languages (Python modules, TypeScript interfaces, Java packages, Go packages, Rust crates, etc.).
|
|
138
|
+
- **SPEC-Guided Architecture**: Domain boundaries follow the SPEC, not language conventions, with the @TAG system ensuring cross-language traceability.
|
|
139
|
+
|
|
140
|
+
### S – SPEC-Compliant Security
|
|
141
|
+
|
|
142
|
+
- **Security Requirements**: Every SPEC explicitly defines security needs, data sensitivity, and access control.
|
|
143
|
+
- **Security by Design**: Implement security controls during the TDD cycle, not after completion.
|
|
144
|
+
- **Language-Agnostic Security Patterns**:
|
|
145
|
+
- Input validation based on SPEC interface definitions
|
|
146
|
+
- Audit logging for SPEC-defined critical operations
|
|
147
|
+
- Access controls aligned with the SPEC permission model
|
|
148
|
+
- Secret management tailored to SPEC environment requirements
|
|
149
|
+
|
|
150
|
+
### T – SPEC Traceability
|
|
151
|
+
|
|
152
|
+
- **Spec-to-Code Traceability**: Every code change references SPEC IDs and requirements through the @TAG system.
|
|
153
|
+
- **Three-Stage Workflow Trace**:
|
|
154
|
+
- `/alfred:1-plan`: Write SPECs with `@SPEC:ID` tags (`.moai/specs/`)
|
|
155
|
+
- `/alfred:2-run`: Implement via TDD with `@TEST:ID` (tests/) → `@CODE:ID` (src/)
|
|
156
|
+
- `/alfred:3-sync`: Sync documentation using `@DOC:ID` (docs/) and validate TAG coverage
|
|
157
|
+
- **Code Scan Verification**: Guarantee TAG traceability by scanning the codebase directly with `rg '@(SPEC|TEST|CODE|DOC):' -n`, without intermediate caches.
|
|
158
|
+
|
|
159
|
+
---
|
|
160
|
+
|
|
161
|
+
## SPEC-First Mindset
|
|
162
|
+
|
|
163
|
+
1. **SPEC-Led Decisions**: Reference an existing SPEC or author a new one before making any technical decision. Never implement without clear requirements.
|
|
164
|
+
2. **SPEC Context Review**: Read the relevant SPEC documents before changing code, understand the @TAG relationships, and confirm compliance.
|
|
165
|
+
3. **SPEC Communication**: Default to English for collaboration. SPEC documents should use precise technical terminology and plain, unambiguous explanations.
|
|
166
|
+
|
|
167
|
+
## SPEC-TDD Workflow
|
|
168
|
+
|
|
169
|
+
1. **Start with the SPEC**: Author or reference a SPEC before writing code. Use `/alfred:1-plan` to clarify requirements, design, and tasks.
|
|
170
|
+
2. **Implement with TDD**: Follow the Red–Green–Refactor loop rigorously using `/alfred:2-run` with language-appropriate testing frameworks.
|
|
171
|
+
3. **Maintain Traceability**: Run `/alfred:3-sync` to update documentation and preserve @TAG relationships between SPECs and code.
|
|
172
|
+
|
|
173
|
+
## @TAG System
|
|
174
|
+
|
|
175
|
+
### Core Chain
|
|
176
|
+
|
|
177
|
+
```text
|
|
178
|
+
@SPEC:ID → @TEST:ID → @CODE:ID → @DOC:ID
|
|
179
|
+
```
|
|
180
|
+
|
|
181
|
+
**Perfect TDD Alignment**:
|
|
182
|
+
- `@SPEC:ID` (Preparation) – requirements authored with the EARS pattern
|
|
183
|
+
- `@TEST:ID` (RED) – failing tests derived from the SPEC
|
|
184
|
+
- `@CODE:ID` (GREEN + REFACTOR) – implementation and refactoring
|
|
185
|
+
- `@DOC:ID` (Documentation) – live documents that capture the outcome
|
|
186
|
+
|
|
187
|
+
### TAG Block Template
|
|
188
|
+
|
|
189
|
+
> **📋 SPEC Metadata Standard (SSOT)**: see `SPEC-METADATA.md`
|
|
190
|
+
|
|
191
|
+
**Every SPEC document must include YAML front matter and a HISTORY section**:
|
|
192
|
+
- **Required Fields (7)**: id, version, status, created, updated, author, priority
|
|
193
|
+
- **Optional Fields (9)**: category, labels, depends_on, blocks, related_specs, related_issue, scope
|
|
194
|
+
- **HISTORY Section**: log every version change (mandatory)
|
|
195
|
+
|
|
196
|
+
Find the complete template, field descriptions, and validation commands in `SPEC-METADATA.md`.
|
|
197
|
+
|
|
198
|
+
**Quick Reference Example**:
|
|
199
|
+
```yaml
|
|
200
|
+
---
|
|
201
|
+
id: AUTH-001
|
|
202
|
+
version: 0.0.1
|
|
203
|
+
status: draft
|
|
204
|
+
created: 2025-09-15
|
|
205
|
+
updated: 2025-09-15
|
|
206
|
+
author: @Goos
|
|
207
|
+
priority: high
|
|
208
|
+
---
|
|
209
|
+
|
|
210
|
+
# @SPEC:AUTH-001: JWT Authentication System
|
|
211
|
+
|
|
212
|
+
## HISTORY
|
|
213
|
+
### v0.0.1 (2025-09-15)
|
|
214
|
+
- **INITIAL**: Authored the JWT authentication system SPEC
|
|
215
|
+
...
|
|
216
|
+
```
|
|
217
|
+
|
|
218
|
+
**Source Code (`src/`)**:
|
|
219
|
+
```text
|
|
220
|
+
# @CODE:AUTH-001 | SPEC: SPEC-AUTH-001.md | TEST: tests/auth/service.test.ts
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
**Test Code (`tests/`)**:
|
|
224
|
+
```text
|
|
225
|
+
# @TEST:AUTH-001 | SPEC: SPEC-AUTH-001.md
|
|
226
|
+
```
|
|
227
|
+
|
|
228
|
+
### @CODE Subcategories (Comment Level)
|
|
229
|
+
|
|
230
|
+
Document implementation details inside `@CODE:ID` blocks:
|
|
231
|
+
- `@CODE:ID:API` – REST APIs, GraphQL endpoints
|
|
232
|
+
- `@CODE:ID:UI` – UI components, views, screens
|
|
233
|
+
- `@CODE:ID:DATA` – data models, schemas, types
|
|
234
|
+
- `@CODE:ID:DOMAIN` – business logic, domain rules
|
|
235
|
+
- `@CODE:ID:INFRA` – infrastructure, databases, integrations
|
|
236
|
+
|
|
237
|
+
### TAG Usage Rules
|
|
238
|
+
|
|
239
|
+
- **TAG ID Format**: `<DOMAIN>-<3 digits>` (e.g., `AUTH-003`) – immutable once created.
|
|
240
|
+
- **Directory Naming**: `.moai/specs/SPEC-{ID}/` (required)
|
|
241
|
+
- ✅ Valid: `SPEC-AUTH-001/`, `SPEC-REFACTOR-001/`, `SPEC-UPDATE-REFACTOR-001/`
|
|
242
|
+
- ❌ Invalid: `AUTH-001/`, `SPEC-001-auth/`, `SPEC-AUTH-001-jwt/`
|
|
243
|
+
- **Composite Domains**: hyphenated combinations allowed (e.g., `UPDATE-REFACTOR-001`)
|
|
244
|
+
- **Guideline**: Prefer fewer than three hyphen segments for clarity
|
|
245
|
+
- **TAG Contents**: May evolve freely; always record the rationale in HISTORY.
|
|
246
|
+
- **Versioning**: Semantic Versioning (v0.0.1 → v0.1.0 → v1.0.0)
|
|
247
|
+
- See `SPEC-METADATA.md#versioning` for details.
|
|
248
|
+
- **Duplicate Check**: Run `rg "@SPEC:{ID}" -n .moai/specs/` before creating a new TAG.
|
|
249
|
+
- **TAG Validation**: `rg '@(SPEC|TEST|CODE|DOC):' -n .moai/specs/ tests/ src/ docs/`
|
|
250
|
+
- **Version Alignment**: `rg "SPEC-{ID}.md v" -n`
|
|
251
|
+
- **Code-First Principle**: The source of truth for TAGs lives in the codebase.
|
|
252
|
+
|
|
253
|
+
### HISTORY Authoring Guide
|
|
254
|
+
|
|
255
|
+
**Change Type Tags**:
|
|
256
|
+
- `INITIAL`: First release (v1.0.0)
|
|
257
|
+
- `ADDED`: New requirement or capability → increment MINOR
|
|
258
|
+
- `CHANGED`: Adjusted behaviour → increment PATCH
|
|
259
|
+
- `FIXED`: Bug or defect fix → increment PATCH
|
|
260
|
+
- `REMOVED`: Removed capability → increment MAJOR
|
|
261
|
+
- `BREAKING`: Backward-incompatible change → increment MAJOR
|
|
262
|
+
- `DEPRECATED`: Marked for future removal
|
|
263
|
+
|
|
264
|
+
**Required Metadata**:
|
|
265
|
+
- `AUTHOR`: Contributor (GitHub ID)
|
|
266
|
+
- `REVIEW`: Reviewer and approval status
|
|
267
|
+
- `REASON`: Why the change was made (optional but recommended for significant updates)
|
|
268
|
+
- `RELATED`: Linked issues/PRs (optional)
|
|
269
|
+
|
|
270
|
+
**HISTORY Search Examples**:
|
|
271
|
+
```bash
|
|
272
|
+
# View the full change log for a TAG
|
|
273
|
+
rg -A 20 "# @SPEC:AUTH-001" .moai/specs/SPEC-AUTH-001.md
|
|
274
|
+
|
|
275
|
+
# Extract only the HISTORY section
|
|
276
|
+
rg -A 50 "## HISTORY" .moai/specs/SPEC-AUTH-001.md
|
|
277
|
+
|
|
278
|
+
# Check the latest entries
|
|
279
|
+
rg "### v[0-9]" .moai/specs/SPEC-AUTH-001.md | head -3
|
|
280
|
+
```
|
|
281
|
+
|
|
282
|
+
---
|
|
283
|
+
|
|
284
|
+
## Development Principles
|
|
285
|
+
|
|
286
|
+
### Code Constraints
|
|
287
|
+
|
|
288
|
+
- ≤ 300 LOC per file
|
|
289
|
+
- ≤ 50 LOC per function
|
|
290
|
+
- ≤ 5 parameters per function
|
|
291
|
+
- Cyclomatic complexity ≤ 10
|
|
292
|
+
|
|
293
|
+
### Quality Benchmarks
|
|
294
|
+
|
|
295
|
+
- ≥ 85% test coverage
|
|
296
|
+
- Use intention-revealing names
|
|
297
|
+
- Prefer guard clauses
|
|
298
|
+
- Leverage language-standard tooling
|
|
299
|
+
|
|
300
|
+
### Refactoring Rules
|
|
301
|
+
|
|
302
|
+
- **Rule of Three**: Plan refactoring when the same pattern appears a third time.
|
|
303
|
+
- **Preparatory Refactoring**: Shape the code for easy change before applying the change.
|
|
304
|
+
- **Tidy as You Go**: Fix small issues immediately; when scope expands, split into a dedicated effort.
|
|
305
|
+
|
|
306
|
+
## Exception Handling
|
|
307
|
+
|
|
308
|
+
When deviating from recommendations, document a waiver and attach it to the relevant PR, issue, or ADR.
|
|
309
|
+
|
|
310
|
+
**Waiver Checklist**:
|
|
311
|
+
|
|
312
|
+
- Justification and evaluated alternatives
|
|
313
|
+
- Risks and mitigation plan
|
|
314
|
+
- Temporary vs. permanent status
|
|
315
|
+
- Expiry conditions and approver
|
|
316
|
+
|
|
317
|
+
## Language Tooling Map
|
|
318
|
+
|
|
319
|
+
- **Python**: pytest (tests), mypy (type checks), black (formatting)
|
|
320
|
+
- **TypeScript**: Vitest (tests), Biome (lint + format)
|
|
321
|
+
- **Java**: JUnit (tests), Maven/Gradle (build)
|
|
322
|
+
- **Go**: go test (tests), gofmt (format)
|
|
323
|
+
- **Rust**: cargo test (tests), rustfmt (format)
|
|
324
|
+
- **Ruby**: RSpec (tests), RuboCop (lint + format), Bundler (packages)
|
|
325
|
+
|
|
326
|
+
## Variable Role Reference
|
|
327
|
+
|
|
328
|
+
| Role | Description | Example |
|
|
329
|
+
| ------------------ | ---------------------------------- | ------------------------------------ |
|
|
330
|
+
| Fixed Value | Constant after initialization | `const MAX_SIZE = 100` |
|
|
331
|
+
| Stepper | Changes sequentially | `for (let i = 0; i < n; i++)` |
|
|
332
|
+
| Flag | Boolean state indicator | `let isValid = true` |
|
|
333
|
+
| Walker | Traverses a data structure | `while (node) { node = node.next; }` |
|
|
334
|
+
| Most Recent Holder | Holds the most recent value | `let lastError` |
|
|
335
|
+
| Most Wanted Holder | Holds optimal/maximum value | `let bestScore = -Infinity` |
|
|
336
|
+
| Gatherer | Accumulator | `sum += value` |
|
|
337
|
+
| Container | Stores multiple values | `const list = []` |
|
|
338
|
+
| Follower | Previous value of another variable | `prev = curr; curr = next;` |
|
|
339
|
+
| Organizer | Reorganizes data | `const sorted = array.sort()` |
|
|
340
|
+
| Temporary | Temporary storage | `const temp = a; a = b; b = temp;` |
|
|
341
|
+
|
|
342
|
+
---
|
|
343
|
+
|
|
344
|
+
This guide defines the standards for executing the three-stage MoAI-ADK pipeline.
|
|
@@ -0,0 +1,330 @@
|
|
|
1
|
+
# GitFlow Protection Policy
|
|
2
|
+
|
|
3
|
+
**Document ID**: @DOC:GITFLOW-POLICY-ALIAS
|
|
4
|
+
**Published**: 2025-10-17
|
|
5
|
+
**Updated**: 2025-10-29
|
|
6
|
+
**Status**: **Enforced via GitHub Branch Protection** (v0.8.3+)
|
|
7
|
+
**Scope**: Personal and Team modes
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## Overview
|
|
12
|
+
|
|
13
|
+
MoAI-ADK **enforces** a GitFlow-inspired workflow through GitHub Branch Protection. As of v0.8.3, the `main` branch is protected and requires Pull Requests for all changes, including from administrators.
|
|
14
|
+
|
|
15
|
+
**What Changed**: Previously (v0.3.5-v0.8.2), we used an advisory approach with warnings. Now we enforce proper GitFlow to ensure code quality and prevent accidental direct pushes to main.
|
|
16
|
+
|
|
17
|
+
## Key Requirements (Enforced)
|
|
18
|
+
|
|
19
|
+
### 1. Main Branch Access (Enforced)
|
|
20
|
+
|
|
21
|
+
| Requirement | Summary | Enforcement |
|
|
22
|
+
|-------------|---------|-------------|
|
|
23
|
+
| **Merge via develop** | MUST merge `develop` into `main` | ✅ Enforced |
|
|
24
|
+
| **Feature branches off develop** | MUST branch from `develop` and raise PRs back to `develop` | ✅ Enforced |
|
|
25
|
+
| **Release process** | Release flow: `develop` → `main` (PR required) | ✅ Enforced |
|
|
26
|
+
| **Force push** | Blocked on `main` | ✅ Blocked |
|
|
27
|
+
| **Direct push** | Blocked on `main` (PR required) | ✅ Blocked |
|
|
28
|
+
|
|
29
|
+
### 2. Git Workflow (Required)
|
|
30
|
+
|
|
31
|
+
```
|
|
32
|
+
┌─────────────────────────────────────────────────────────┐
|
|
33
|
+
│ ENFORCED GITFLOW │
|
|
34
|
+
│ (GitHub Branch Protection Active) │
|
|
35
|
+
└─────────────────────────────────────────────────────────┘
|
|
36
|
+
|
|
37
|
+
develop (required base branch)
|
|
38
|
+
↑ ↓
|
|
39
|
+
┌─────────────────┐
|
|
40
|
+
│ │
|
|
41
|
+
│ developer work │
|
|
42
|
+
│ │
|
|
43
|
+
↓ ↑
|
|
44
|
+
feature/SPEC-{ID} [PR: feature -> develop]
|
|
45
|
+
[code review + approval]
|
|
46
|
+
[Merge to develop]
|
|
47
|
+
|
|
48
|
+
develop (stable)
|
|
49
|
+
↓
|
|
50
|
+
│ (release manager prepares)
|
|
51
|
+
↓
|
|
52
|
+
[PR: develop -> main]
|
|
53
|
+
[Code review + approval REQUIRED]
|
|
54
|
+
[All discussions resolved]
|
|
55
|
+
[CI/CD validation]
|
|
56
|
+
[tag creation]
|
|
57
|
+
↓
|
|
58
|
+
main (protected release)
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
**Enforcement**: Direct pushes to `main` are **blocked** via GitHub Branch Protection. All changes must go through Pull Requests.
|
|
62
|
+
|
|
63
|
+
## Technical Implementation
|
|
64
|
+
|
|
65
|
+
### Pre-push Hook (Advisory Mode)
|
|
66
|
+
|
|
67
|
+
**Location**: `.git/hooks/pre-push`
|
|
68
|
+
**Purpose**: Warn on `main` branch pushes without blocking them
|
|
69
|
+
|
|
70
|
+
```bash
|
|
71
|
+
# When attempting to push to main:
|
|
72
|
+
⚠️ ADVISORY: Non-standard GitFlow detected
|
|
73
|
+
|
|
74
|
+
Current branch: feature/SPEC-123
|
|
75
|
+
Target branch: main
|
|
76
|
+
|
|
77
|
+
Recommended GitFlow workflow:
|
|
78
|
+
1. Work on feature/SPEC-{ID} branch (created from develop)
|
|
79
|
+
2. Push to feature/SPEC-{ID} and create PR to develop
|
|
80
|
+
3. Merge into develop after code review
|
|
81
|
+
4. When develop is stable, create PR from develop to main
|
|
82
|
+
5. Release manager merges develop -> main with tag
|
|
83
|
+
|
|
84
|
+
✓ Push will proceed (flexibility mode enabled)
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
### Force Push Advisory
|
|
88
|
+
|
|
89
|
+
```bash
|
|
90
|
+
⚠️ ADVISORY: Force-push to main branch detected
|
|
91
|
+
|
|
92
|
+
Recommended approach:
|
|
93
|
+
- Use GitHub PR with proper code review
|
|
94
|
+
- Ensure changes are merged via fast-forward
|
|
95
|
+
|
|
96
|
+
✓ Push will proceed (flexibility mode enabled)
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
---
|
|
100
|
+
|
|
101
|
+
## Workflow Examples
|
|
102
|
+
|
|
103
|
+
### Scenario 1: Standard Feature Development (Recommended)
|
|
104
|
+
|
|
105
|
+
```bash
|
|
106
|
+
# 1. Sync latest code from develop
|
|
107
|
+
git checkout develop
|
|
108
|
+
git pull origin develop
|
|
109
|
+
|
|
110
|
+
# 2. Create a feature branch (from develop)
|
|
111
|
+
git checkout -b feature/SPEC-001-new-feature
|
|
112
|
+
|
|
113
|
+
# 3. Implement the change
|
|
114
|
+
# ... write code and tests ...
|
|
115
|
+
|
|
116
|
+
# 4. Commit
|
|
117
|
+
git add .
|
|
118
|
+
git commit -m "..."
|
|
119
|
+
|
|
120
|
+
# 5. Push
|
|
121
|
+
git push origin feature/SPEC-001-new-feature
|
|
122
|
+
|
|
123
|
+
# 6. Open a PR: feature/SPEC-001-new-feature -> develop
|
|
124
|
+
|
|
125
|
+
# 7. Merge into develop after review and approval
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
### Scenario 2: Fast Hotfix (Flexible)
|
|
129
|
+
|
|
130
|
+
```bash
|
|
131
|
+
# When an urgent fix is required:
|
|
132
|
+
|
|
133
|
+
# Option 1: Recommended (via develop)
|
|
134
|
+
git checkout develop
|
|
135
|
+
git checkout -b hotfix/critical-bug
|
|
136
|
+
# ... apply fix ...
|
|
137
|
+
git push origin hotfix/critical-bug
|
|
138
|
+
# Open PRs: hotfix -> develop -> main
|
|
139
|
+
|
|
140
|
+
# Option 2: Direct fix on main (allowed, not recommended)
|
|
141
|
+
git checkout main
|
|
142
|
+
# ... apply fix ...
|
|
143
|
+
git commit -m "Fix critical bug"
|
|
144
|
+
git push origin main # ⚠️ Advisory warning appears but push continues
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
### Scenario 3: Release (Standard or Flexible)
|
|
148
|
+
|
|
149
|
+
```bash
|
|
150
|
+
# Standard approach (recommended):
|
|
151
|
+
git checkout develop
|
|
152
|
+
gh pr create --base main --head develop --title "Release v1.0.0"
|
|
153
|
+
|
|
154
|
+
# Direct push (allowed):
|
|
155
|
+
git checkout develop
|
|
156
|
+
git push origin main # ⚠️ Advisory warning appears but push continues
|
|
157
|
+
git tag -a v1.0.0 -m "Release v1.0.0"
|
|
158
|
+
git push origin v1.0.0
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
---
|
|
162
|
+
|
|
163
|
+
## Policy Modes
|
|
164
|
+
|
|
165
|
+
### Strict Mode (Active, v0.8.3+) ✅ ENFORCED
|
|
166
|
+
|
|
167
|
+
**GitHub Branch Protection Enabled**:
|
|
168
|
+
- ✅ **enforce_admins: true** - Administrators must follow all rules
|
|
169
|
+
- ✅ **required_pull_request_reviews** - 1 approval required
|
|
170
|
+
- ✅ **required_conversation_resolution** - All discussions must be resolved
|
|
171
|
+
- ✅ **Block direct pushes to `main`** - PR required for all users
|
|
172
|
+
- ✅ **Block force pushes** - Prevents history rewriting
|
|
173
|
+
- ✅ **Block branch deletion** - Protects main from accidental deletion
|
|
174
|
+
|
|
175
|
+
**What This Means**:
|
|
176
|
+
- ❌ No one (including admins) can push directly to `main`
|
|
177
|
+
- ✅ All changes must go through Pull Requests
|
|
178
|
+
- ✅ PRs require code review approval
|
|
179
|
+
- ✅ All code discussions must be resolved before merge
|
|
180
|
+
- ✅ Enforces proper GitFlow: feature → develop → main
|
|
181
|
+
|
|
182
|
+
### Advisory Mode (Legacy, v0.3.5 - v0.8.2)
|
|
183
|
+
|
|
184
|
+
- ⚠️ Warned but allowed direct pushes to `main`
|
|
185
|
+
- ⚠️ Warned but allowed force pushes
|
|
186
|
+
- ⚠️ Recommended best practices while preserving flexibility
|
|
187
|
+
- ❌ **Deprecated** - Replaced by Strict Mode for better quality control
|
|
188
|
+
|
|
189
|
+
---
|
|
190
|
+
|
|
191
|
+
## Recommended Checklist
|
|
192
|
+
|
|
193
|
+
Every contributor should ensure:
|
|
194
|
+
|
|
195
|
+
- [ ] `.git/hooks/pre-push` exists and is executable (755)
|
|
196
|
+
- [ ] Feature branches fork from `develop`
|
|
197
|
+
- [ ] Pull requests target `develop`
|
|
198
|
+
- [ ] Releases merge `develop` → `main`
|
|
199
|
+
|
|
200
|
+
**Verification Commands**:
|
|
201
|
+
```bash
|
|
202
|
+
ls -la .git/hooks/pre-push
|
|
203
|
+
git branch -vv
|
|
204
|
+
```
|
|
205
|
+
|
|
206
|
+
---
|
|
207
|
+
|
|
208
|
+
## FAQ
|
|
209
|
+
|
|
210
|
+
**Q: Can we merge into `main` from branches other than `develop`?**
|
|
211
|
+
A: Yes. You will see an advisory warning, but the merge proceeds. The recommended path remains `develop` → `main`.
|
|
212
|
+
|
|
213
|
+
**Q: Are force pushes allowed?**
|
|
214
|
+
A: Yes. You receive a warning, but the push succeeds. Use with caution.
|
|
215
|
+
|
|
216
|
+
**Q: Can we commit/push directly to `main`?**
|
|
217
|
+
A: Yes. Expect an advisory warning, yet the push continues.
|
|
218
|
+
|
|
219
|
+
**Q: Can I disable the hook entirely?**
|
|
220
|
+
A: Yes. Remove `.git/hooks/pre-push` or strip its execute permission.
|
|
221
|
+
|
|
222
|
+
**Q: Why switch to Advisory Mode?**
|
|
223
|
+
A: Advisory Mode was used in v0.3.5-v0.8.2. As of v0.8.3, we've switched to Strict Mode with GitHub Branch Protection for better quality control.
|
|
224
|
+
|
|
225
|
+
**Q: What if develop falls behind main?**
|
|
226
|
+
A: This can happen when hotfixes or releases go directly to main. Regularly sync main → develop to prevent divergence. See "Maintaining develop-main Sync" section below.
|
|
227
|
+
|
|
228
|
+
**Q: Can I bypass branch protection in emergencies?**
|
|
229
|
+
A: No. Even administrators must follow the PR process. For true emergencies, temporarily disable protection via GitHub Settings (requires admin access), but re-enable immediately after.
|
|
230
|
+
|
|
231
|
+
---
|
|
232
|
+
|
|
233
|
+
## Maintaining develop-main Sync
|
|
234
|
+
|
|
235
|
+
### ⚠️ Critical Rule: develop Must Stay Current
|
|
236
|
+
|
|
237
|
+
**Problem**: When main receives direct commits (hotfixes, emergency releases) without syncing back to develop, GitFlow breaks:
|
|
238
|
+
|
|
239
|
+
```
|
|
240
|
+
❌ BAD STATE:
|
|
241
|
+
develop: 3 commits ahead, 29 commits behind main
|
|
242
|
+
- develop has outdated dependencies
|
|
243
|
+
- New features branch from old code
|
|
244
|
+
- Merge conflicts multiply over time
|
|
245
|
+
```
|
|
246
|
+
|
|
247
|
+
### Signs of Drift
|
|
248
|
+
|
|
249
|
+
Monitor for these warnings:
|
|
250
|
+
- `git status` shows "Your branch is X commits behind main"
|
|
251
|
+
- Feature branches conflict with main during PR
|
|
252
|
+
- CI/CD failures due to dependency mismatches
|
|
253
|
+
- Version numbers in develop don't match main
|
|
254
|
+
|
|
255
|
+
### Recovery Procedure
|
|
256
|
+
|
|
257
|
+
When develop falls behind main:
|
|
258
|
+
|
|
259
|
+
1. **Assess the Gap**
|
|
260
|
+
```bash
|
|
261
|
+
git log --oneline develop..main # Commits in main but not develop
|
|
262
|
+
git log --oneline main..develop # Commits in develop but not main
|
|
263
|
+
```
|
|
264
|
+
|
|
265
|
+
2. **Sync Strategy: Merge main into develop (Recommended)**
|
|
266
|
+
```bash
|
|
267
|
+
git checkout develop
|
|
268
|
+
git pull origin develop # Get latest develop
|
|
269
|
+
git merge main # Merge main into develop
|
|
270
|
+
# Resolve conflicts if any (prefer main for version/config files)
|
|
271
|
+
git push origin develop
|
|
272
|
+
```
|
|
273
|
+
|
|
274
|
+
3. **Emergency Only: Reset develop to main (Destructive)**
|
|
275
|
+
```bash
|
|
276
|
+
# ⚠️ ONLY if develop's unique commits are unwanted
|
|
277
|
+
git checkout develop
|
|
278
|
+
git reset --hard main
|
|
279
|
+
git push origin develop --force
|
|
280
|
+
```
|
|
281
|
+
|
|
282
|
+
### Prevention: Regular Sync Schedule
|
|
283
|
+
|
|
284
|
+
**After every main release** (REQUIRED):
|
|
285
|
+
```bash
|
|
286
|
+
# Immediately after merging develop → main:
|
|
287
|
+
git checkout develop
|
|
288
|
+
git merge main
|
|
289
|
+
git push origin develop
|
|
290
|
+
```
|
|
291
|
+
|
|
292
|
+
**Weekly maintenance** (for active projects):
|
|
293
|
+
```bash
|
|
294
|
+
# Every Monday morning:
|
|
295
|
+
git checkout develop
|
|
296
|
+
git pull origin main
|
|
297
|
+
git push origin develop
|
|
298
|
+
```
|
|
299
|
+
|
|
300
|
+
### Real-World Case Study (2025-10-29)
|
|
301
|
+
|
|
302
|
+
**Situation**: develop was 29 commits behind main due to:
|
|
303
|
+
- v0.8.2, v0.8.3 released directly to main
|
|
304
|
+
- No reverse sync to develop
|
|
305
|
+
- Feature branches contained outdated code
|
|
306
|
+
|
|
307
|
+
**Resolution**:
|
|
308
|
+
- Merged main → develop (14 file conflicts)
|
|
309
|
+
- Resolved conflicts prioritizing main's versions
|
|
310
|
+
- TAG validation bypassed for merge commit
|
|
311
|
+
- Enabled Strict Mode to prevent future direct pushes
|
|
312
|
+
|
|
313
|
+
**Lesson**: With Strict Mode active, this won't happen again. All releases must go through develop → main PR flow.
|
|
314
|
+
|
|
315
|
+
---
|
|
316
|
+
|
|
317
|
+
## Policy Change Log
|
|
318
|
+
|
|
319
|
+
| Date | Change | Owner |
|
|
320
|
+
|------|------|--------|
|
|
321
|
+
| 2025-10-17 | Initial policy drafted (Strict Mode) | git-manager |
|
|
322
|
+
| 2025-10-17 | Switched to Advisory Mode (warnings only) | git-manager |
|
|
323
|
+
| 2025-10-29 | **Enabled GitHub Branch Protection (Strict Mode)** | Alfred |
|
|
324
|
+
| 2025-10-29 | Added develop-main sync guidelines and real-world case study | Alfred |
|
|
325
|
+
| 2025-10-29 | Enforced `enforce_admins`, `required_conversation_resolution` | Alfred |
|
|
326
|
+
|
|
327
|
+
---
|
|
328
|
+
|
|
329
|
+
**This policy is advisory—adapt it to fit your project needs.**
|
|
330
|
+
**Reach out to the team lead or release engineer for questions or suggestions.**
|