universal-dev-standards 3.5.1-beta.1 → 3.5.1-beta.11
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.
- package/bin/uds.js +2 -0
- package/bundled/core/ai-instruction-standards.md +205 -0
- package/bundled/core/anti-hallucination.md +684 -0
- package/bundled/core/changelog-standards.md +556 -0
- package/bundled/core/checkin-standards.md +935 -0
- package/bundled/core/code-review-checklist.md +684 -0
- package/bundled/core/commit-message-guide.md +915 -0
- package/bundled/core/documentation-structure.md +1117 -0
- package/bundled/core/documentation-writing-standards.md +487 -0
- package/bundled/core/error-code-standards.md +382 -0
- package/bundled/core/git-workflow.md +859 -0
- package/bundled/core/logging-standards.md +323 -0
- package/bundled/core/project-structure.md +354 -0
- package/bundled/core/refactoring-standards.md +636 -0
- package/bundled/core/spec-driven-development.md +207 -0
- package/bundled/core/test-completeness-dimensions.md +536 -0
- package/bundled/core/test-driven-development.md +995 -0
- package/bundled/core/testing-standards.md +3061 -0
- package/bundled/core/versioning.md +902 -0
- package/bundled/locales/README.md +88 -0
- package/bundled/locales/zh-CN/CHANGELOG.md +705 -0
- package/bundled/locales/zh-CN/CLAUDE.md +213 -0
- package/bundled/locales/zh-CN/MAINTENANCE.md +689 -0
- package/bundled/locales/zh-CN/README.md +707 -0
- package/bundled/locales/zh-CN/STANDARDS-MAPPING.md +177 -0
- package/bundled/locales/zh-CN/adoption/ADOPTION-GUIDE.md +392 -0
- package/bundled/locales/zh-CN/adoption/STATIC-DYNAMIC-GUIDE.md +302 -0
- package/bundled/locales/zh-CN/adoption/checklists/enterprise.md +332 -0
- package/bundled/locales/zh-CN/adoption/checklists/minimal.md +141 -0
- package/bundled/locales/zh-CN/adoption/checklists/recommended.md +272 -0
- package/bundled/locales/zh-CN/ai/MAINTENANCE.md +739 -0
- package/bundled/locales/zh-CN/ai/options/changelog/auto-generated.ai.yaml +76 -0
- package/bundled/locales/zh-CN/ai/options/changelog/keep-a-changelog.ai.yaml +99 -0
- package/bundled/locales/zh-CN/ai/options/code-review/automated-review.ai.yaml +120 -0
- package/bundled/locales/zh-CN/ai/options/code-review/pair-programming.ai.yaml +109 -0
- package/bundled/locales/zh-CN/ai/options/code-review/pr-review.ai.yaml +104 -0
- package/bundled/locales/zh-CN/ai/options/commit-message/bilingual.ai.yaml +105 -0
- package/bundled/locales/zh-CN/ai/options/commit-message/english.ai.yaml +79 -0
- package/bundled/locales/zh-CN/ai/options/commit-message/traditional-chinese.ai.yaml +100 -0
- package/bundled/locales/zh-CN/ai/options/documentation/api-docs.ai.yaml +140 -0
- package/bundled/locales/zh-CN/ai/options/documentation/markdown-docs.ai.yaml +89 -0
- package/bundled/locales/zh-CN/ai/options/documentation/wiki-style.ai.yaml +119 -0
- package/bundled/locales/zh-CN/ai/options/git-workflow/gitflow.ai.yaml +133 -0
- package/bundled/locales/zh-CN/ai/options/git-workflow/github-flow.ai.yaml +73 -0
- package/bundled/locales/zh-CN/ai/options/git-workflow/merge-commit.ai.yaml +88 -0
- package/bundled/locales/zh-CN/ai/options/git-workflow/rebase-ff.ai.yaml +113 -0
- package/bundled/locales/zh-CN/ai/options/git-workflow/squash-merge.ai.yaml +85 -0
- package/bundled/locales/zh-CN/ai/options/git-workflow/trunk-based.ai.yaml +117 -0
- package/bundled/locales/zh-CN/ai/options/project-structure/dotnet.ai.yaml +108 -0
- package/bundled/locales/zh-CN/ai/options/project-structure/go.ai.yaml +115 -0
- package/bundled/locales/zh-CN/ai/options/project-structure/java.ai.yaml +113 -0
- package/bundled/locales/zh-CN/ai/options/project-structure/kotlin.ai.yaml +123 -0
- package/bundled/locales/zh-CN/ai/options/project-structure/nodejs.ai.yaml +101 -0
- package/bundled/locales/zh-CN/ai/options/project-structure/php.ai.yaml +147 -0
- package/bundled/locales/zh-CN/ai/options/project-structure/python.ai.yaml +116 -0
- package/bundled/locales/zh-CN/ai/options/project-structure/ruby.ai.yaml +140 -0
- package/bundled/locales/zh-CN/ai/options/project-structure/rust.ai.yaml +117 -0
- package/bundled/locales/zh-CN/ai/options/project-structure/swift.ai.yaml +143 -0
- package/bundled/locales/zh-CN/ai/options/testing/contract-testing.ai.yaml +254 -0
- package/bundled/locales/zh-CN/ai/options/testing/e2e-testing.ai.yaml +116 -0
- package/bundled/locales/zh-CN/ai/options/testing/industry-pyramid.ai.yaml +144 -0
- package/bundled/locales/zh-CN/ai/options/testing/integration-testing.ai.yaml +90 -0
- package/bundled/locales/zh-CN/ai/options/testing/istqb-framework.ai.yaml +108 -0
- package/bundled/locales/zh-CN/ai/options/testing/performance-testing.ai.yaml +272 -0
- package/bundled/locales/zh-CN/ai/options/testing/security-testing.ai.yaml +160 -0
- package/bundled/locales/zh-CN/ai/options/testing/system-testing.ai.yaml +101 -0
- package/bundled/locales/zh-CN/ai/options/testing/unit-testing.ai.yaml +82 -0
- package/bundled/locales/zh-CN/ai/standards/anti-hallucination.ai.yaml +145 -0
- package/bundled/locales/zh-CN/ai/standards/changelog.ai.yaml +146 -0
- package/bundled/locales/zh-CN/ai/standards/checkin-standards.ai.yaml +170 -0
- package/bundled/locales/zh-CN/ai/standards/code-review.ai.yaml +148 -0
- package/bundled/locales/zh-CN/ai/standards/commit-message.ai.yaml +175 -0
- package/bundled/locales/zh-CN/ai/standards/documentation-structure.ai.yaml +124 -0
- package/bundled/locales/zh-CN/ai/standards/documentation-writing-standards.ai.yaml +190 -0
- package/bundled/locales/zh-CN/ai/standards/error-codes.ai.yaml +139 -0
- package/bundled/locales/zh-CN/ai/standards/git-workflow.ai.yaml +95 -0
- package/bundled/locales/zh-CN/ai/standards/logging.ai.yaml +128 -0
- package/bundled/locales/zh-CN/ai/standards/project-structure.ai.yaml +134 -0
- package/bundled/locales/zh-CN/ai/standards/spec-driven-development.ai.yaml +169 -0
- package/bundled/locales/zh-CN/ai/standards/test-completeness-dimensions.ai.yaml +220 -0
- package/bundled/locales/zh-CN/ai/standards/testing.ai.yaml +137 -0
- package/bundled/locales/zh-CN/ai/standards/versioning.ai.yaml +211 -0
- package/bundled/locales/zh-CN/core/ai-instruction-standards.md +213 -0
- package/bundled/locales/zh-CN/core/anti-hallucination.md +691 -0
- package/bundled/locales/zh-CN/core/changelog-standards.md +147 -0
- package/bundled/locales/zh-CN/core/checkin-standards.md +943 -0
- package/bundled/locales/zh-CN/core/code-review-guide.md +693 -0
- package/bundled/locales/zh-CN/core/commit-message-guide.md +129 -0
- package/bundled/locales/zh-CN/core/documentation-structure.md +173 -0
- package/bundled/locales/zh-CN/core/documentation-writing-standards.md +495 -0
- package/bundled/locales/zh-CN/core/error-code-standards.md +180 -0
- package/bundled/locales/zh-CN/core/git-workflow.md +193 -0
- package/bundled/locales/zh-CN/core/logging-standards.md +174 -0
- package/bundled/locales/zh-CN/core/project-structure.md +184 -0
- package/bundled/locales/zh-CN/core/refactoring-standards.md +642 -0
- package/bundled/locales/zh-CN/core/spec-driven-development.md +215 -0
- package/bundled/locales/zh-CN/core/test-completeness-dimensions.md +544 -0
- package/bundled/locales/zh-CN/core/test-driven-development.md +1002 -0
- package/bundled/locales/zh-CN/core/testing-standards.md +170 -0
- package/bundled/locales/zh-CN/core/versioning.md +177 -0
- package/bundled/locales/zh-CN/docs/AI-AGENT-ROADMAP.md +303 -0
- package/bundled/locales/zh-CN/docs/CLI-INIT-OPTIONS.md +990 -0
- package/bundled/locales/zh-CN/docs/OPERATION-WORKFLOW.md +1064 -0
- package/bundled/locales/zh-CN/docs/USAGE-MODES-COMPARISON.md +333 -0
- package/bundled/locales/zh-CN/docs/WINDOWS-GUIDE.md +215 -0
- package/bundled/locales/zh-CN/integrations/codex/AGENTS.md +115 -0
- package/bundled/locales/zh-CN/integrations/codex/README.md +67 -0
- package/bundled/locales/zh-CN/integrations/gemini-cli/GEMINI.md +102 -0
- package/bundled/locales/zh-CN/integrations/gemini-cli/README.md +140 -0
- package/bundled/locales/zh-CN/integrations/github-copilot/COPILOT-CHAT-REFERENCE.md +269 -0
- package/bundled/locales/zh-CN/integrations/github-copilot/README.md +167 -0
- package/bundled/locales/zh-CN/integrations/github-copilot/copilot-instructions.md +263 -0
- package/bundled/locales/zh-CN/integrations/github-copilot/skills-mapping.md +192 -0
- package/bundled/locales/zh-CN/integrations/google-antigravity/INSTRUCTIONS.md +61 -0
- package/bundled/locales/zh-CN/integrations/google-antigravity/README.md +84 -0
- package/bundled/locales/zh-CN/integrations/opencode/AGENTS.md +111 -0
- package/bundled/locales/zh-CN/integrations/opencode/README.md +176 -0
- package/bundled/locales/zh-CN/integrations/opencode/skills-mapping.md +396 -0
- package/bundled/locales/zh-CN/integrations/openspec/AGENTS.md +301 -0
- package/bundled/locales/zh-CN/integrations/openspec/README.md +43 -0
- package/bundled/locales/zh-CN/integrations/spec-kit/AGENTS.md +184 -0
- package/bundled/locales/zh-CN/integrations/spec-kit/README.md +43 -0
- package/bundled/locales/zh-CN/options/commit-message/bilingual.md +161 -0
- package/bundled/locales/zh-CN/options/commit-message/english.md +137 -0
- package/bundled/locales/zh-CN/options/commit-message/traditional-chinese.md +162 -0
- package/bundled/locales/zh-CN/options/git-workflow/gitflow.md +147 -0
- package/bundled/locales/zh-CN/options/git-workflow/github-flow.md +124 -0
- package/bundled/locales/zh-CN/options/git-workflow/merge-commit.md +124 -0
- package/bundled/locales/zh-CN/options/git-workflow/rebase-ff.md +160 -0
- package/bundled/locales/zh-CN/options/git-workflow/squash-merge.md +117 -0
- package/bundled/locales/zh-CN/options/git-workflow/trunk-based.md +125 -0
- package/bundled/locales/zh-CN/options/project-structure/dotnet.md +183 -0
- package/bundled/locales/zh-CN/options/project-structure/go.md +226 -0
- package/bundled/locales/zh-CN/options/project-structure/java.md +213 -0
- package/bundled/locales/zh-CN/options/project-structure/nodejs.md +185 -0
- package/bundled/locales/zh-CN/options/project-structure/python.md +229 -0
- package/bundled/locales/zh-CN/options/testing/e2e-testing.md +207 -0
- package/bundled/locales/zh-CN/options/testing/integration-testing.md +230 -0
- package/bundled/locales/zh-CN/options/testing/system-testing.md +183 -0
- package/bundled/locales/zh-CN/options/testing/unit-testing.md +165 -0
- package/bundled/locales/zh-CN/skills/INTEGRATION-GUIDE.md +218 -0
- package/bundled/locales/zh-CN/skills/README.md +134 -0
- package/bundled/locales/zh-CN/skills/_shared/README.md +68 -0
- package/bundled/locales/zh-CN/skills/claude-code/CONTRIBUTING.template.md +151 -0
- package/bundled/locales/zh-CN/skills/claude-code/README.md +174 -0
- package/bundled/locales/zh-CN/skills/claude-code/ai-collaboration-standards/SKILL.md +175 -0
- package/bundled/locales/zh-CN/skills/claude-code/ai-collaboration-standards/anti-hallucination.md +223 -0
- package/bundled/locales/zh-CN/skills/claude-code/ai-collaboration-standards/certainty-labels.md +132 -0
- package/bundled/locales/zh-CN/skills/claude-code/changelog-guide/SKILL.md +237 -0
- package/bundled/locales/zh-CN/skills/claude-code/checkin-assistant/SKILL.md +407 -0
- package/bundled/locales/zh-CN/skills/claude-code/code-review-assistant/SKILL.md +154 -0
- package/bundled/locales/zh-CN/skills/claude-code/code-review-assistant/checkin-checklist.md +257 -0
- package/bundled/locales/zh-CN/skills/claude-code/code-review-assistant/review-checklist.md +246 -0
- package/bundled/locales/zh-CN/skills/claude-code/commands/bdd.md +142 -0
- package/bundled/locales/zh-CN/skills/claude-code/commands/methodology.md +274 -0
- package/bundled/locales/zh-CN/skills/claude-code/commit-standards/SKILL.md +191 -0
- package/bundled/locales/zh-CN/skills/claude-code/commit-standards/conventional-commits.md +264 -0
- package/bundled/locales/zh-CN/skills/claude-code/commit-standards/language-options.md +172 -0
- package/bundled/locales/zh-CN/skills/claude-code/documentation-guide/SKILL.md +421 -0
- package/bundled/locales/zh-CN/skills/claude-code/documentation-guide/documentation-structure.md +357 -0
- package/bundled/locales/zh-CN/skills/claude-code/documentation-guide/readme-template.md +412 -0
- package/bundled/locales/zh-CN/skills/claude-code/error-code-guide/SKILL.md +269 -0
- package/bundled/locales/zh-CN/skills/claude-code/git-workflow-guide/SKILL.md +218 -0
- package/bundled/locales/zh-CN/skills/claude-code/git-workflow-guide/branch-naming.md +220 -0
- package/bundled/locales/zh-CN/skills/claude-code/git-workflow-guide/git-workflow.md +321 -0
- package/bundled/locales/zh-CN/skills/claude-code/logging-guide/SKILL.md +285 -0
- package/bundled/locales/zh-CN/skills/claude-code/methodology-system/SKILL.md +131 -0
- package/bundled/locales/zh-CN/skills/claude-code/methodology-system/create-methodology.md +350 -0
- package/bundled/locales/zh-CN/skills/claude-code/methodology-system/runtime.md +279 -0
- package/bundled/locales/zh-CN/skills/claude-code/project-structure-guide/SKILL.md +143 -0
- package/bundled/locales/zh-CN/skills/claude-code/project-structure-guide/language-patterns.md +271 -0
- package/bundled/locales/zh-CN/skills/claude-code/refactoring-assistant/SKILL.md +162 -0
- package/bundled/locales/zh-CN/skills/claude-code/release-standards/SKILL.md +191 -0
- package/bundled/locales/zh-CN/skills/claude-code/release-standards/changelog-format.md +247 -0
- package/bundled/locales/zh-CN/skills/claude-code/release-standards/release-workflow.md +345 -0
- package/bundled/locales/zh-CN/skills/claude-code/release-standards/semantic-versioning.md +250 -0
- package/bundled/locales/zh-CN/skills/claude-code/requirement-assistant/SKILL.md +227 -0
- package/bundled/locales/zh-CN/skills/claude-code/requirement-assistant/requirement-checklist.md +325 -0
- package/bundled/locales/zh-CN/skills/claude-code/requirement-assistant/requirement-writing.md +399 -0
- package/bundled/locales/zh-CN/skills/claude-code/spec-driven-dev/SKILL.md +243 -0
- package/bundled/locales/zh-CN/skills/claude-code/tdd-assistant/SKILL.md +332 -0
- package/bundled/locales/zh-CN/skills/claude-code/tdd-assistant/language-examples.md +639 -0
- package/bundled/locales/zh-CN/skills/claude-code/tdd-assistant/tdd-workflow.md +486 -0
- package/bundled/locales/zh-CN/skills/claude-code/test-coverage-assistant/SKILL.md +282 -0
- package/bundled/locales/zh-CN/skills/claude-code/testing-guide/SKILL.md +234 -0
- package/bundled/locales/zh-CN/skills/claude-code/testing-guide/testing-pyramid.md +448 -0
- package/bundled/locales/zh-CN/skills/cline/README.md +58 -0
- package/bundled/locales/zh-CN/skills/copilot/README.md +61 -0
- package/bundled/locales/zh-CN/skills/copilot/copilot-instructions.md +79 -0
- package/bundled/locales/zh-CN/skills/cursor/README.md +58 -0
- package/bundled/locales/zh-CN/skills/windsurf/README.md +59 -0
- package/bundled/locales/zh-TW/CHANGELOG.md +707 -0
- package/bundled/locales/zh-TW/CLAUDE.md +213 -0
- package/bundled/locales/zh-TW/MAINTENANCE.md +683 -0
- package/bundled/locales/zh-TW/README.md +687 -0
- package/bundled/locales/zh-TW/STANDARDS-MAPPING.md +177 -0
- package/bundled/locales/zh-TW/adoption/ADOPTION-GUIDE.md +392 -0
- package/bundled/locales/zh-TW/adoption/STATIC-DYNAMIC-GUIDE.md +299 -0
- package/bundled/locales/zh-TW/adoption/checklists/enterprise.md +332 -0
- package/bundled/locales/zh-TW/adoption/checklists/minimal.md +141 -0
- package/bundled/locales/zh-TW/adoption/checklists/recommended.md +272 -0
- package/bundled/locales/zh-TW/ai/MAINTENANCE.md +754 -0
- package/bundled/locales/zh-TW/ai/options/changelog/auto-generated.ai.yaml +76 -0
- package/bundled/locales/zh-TW/ai/options/changelog/keep-a-changelog.ai.yaml +99 -0
- package/bundled/locales/zh-TW/ai/options/code-review/automated-review.ai.yaml +120 -0
- package/bundled/locales/zh-TW/ai/options/code-review/pair-programming.ai.yaml +109 -0
- package/bundled/locales/zh-TW/ai/options/code-review/pr-review.ai.yaml +104 -0
- package/bundled/locales/zh-TW/ai/options/commit-message/bilingual.ai.yaml +105 -0
- package/bundled/locales/zh-TW/ai/options/commit-message/english.ai.yaml +79 -0
- package/bundled/locales/zh-TW/ai/options/commit-message/traditional-chinese.ai.yaml +100 -0
- package/bundled/locales/zh-TW/ai/options/documentation/api-docs.ai.yaml +140 -0
- package/bundled/locales/zh-TW/ai/options/documentation/markdown-docs.ai.yaml +89 -0
- package/bundled/locales/zh-TW/ai/options/documentation/wiki-style.ai.yaml +119 -0
- package/bundled/locales/zh-TW/ai/options/git-workflow/gitflow.ai.yaml +133 -0
- package/bundled/locales/zh-TW/ai/options/git-workflow/github-flow.ai.yaml +73 -0
- package/bundled/locales/zh-TW/ai/options/git-workflow/merge-commit.ai.yaml +88 -0
- package/bundled/locales/zh-TW/ai/options/git-workflow/rebase-ff.ai.yaml +113 -0
- package/bundled/locales/zh-TW/ai/options/git-workflow/squash-merge.ai.yaml +85 -0
- package/bundled/locales/zh-TW/ai/options/git-workflow/trunk-based.ai.yaml +117 -0
- package/bundled/locales/zh-TW/ai/options/project-structure/dotnet.ai.yaml +108 -0
- package/bundled/locales/zh-TW/ai/options/project-structure/go.ai.yaml +115 -0
- package/bundled/locales/zh-TW/ai/options/project-structure/java.ai.yaml +113 -0
- package/bundled/locales/zh-TW/ai/options/project-structure/kotlin.ai.yaml +123 -0
- package/bundled/locales/zh-TW/ai/options/project-structure/nodejs.ai.yaml +101 -0
- package/bundled/locales/zh-TW/ai/options/project-structure/php.ai.yaml +147 -0
- package/bundled/locales/zh-TW/ai/options/project-structure/python.ai.yaml +116 -0
- package/bundled/locales/zh-TW/ai/options/project-structure/ruby.ai.yaml +140 -0
- package/bundled/locales/zh-TW/ai/options/project-structure/rust.ai.yaml +117 -0
- package/bundled/locales/zh-TW/ai/options/project-structure/swift.ai.yaml +143 -0
- package/bundled/locales/zh-TW/ai/options/testing/contract-testing.ai.yaml +254 -0
- package/bundled/locales/zh-TW/ai/options/testing/e2e-testing.ai.yaml +116 -0
- package/bundled/locales/zh-TW/ai/options/testing/industry-pyramid.ai.yaml +144 -0
- package/bundled/locales/zh-TW/ai/options/testing/integration-testing.ai.yaml +90 -0
- package/bundled/locales/zh-TW/ai/options/testing/istqb-framework.ai.yaml +108 -0
- package/bundled/locales/zh-TW/ai/options/testing/performance-testing.ai.yaml +272 -0
- package/bundled/locales/zh-TW/ai/options/testing/security-testing.ai.yaml +160 -0
- package/bundled/locales/zh-TW/ai/options/testing/system-testing.ai.yaml +101 -0
- package/bundled/locales/zh-TW/ai/options/testing/unit-testing.ai.yaml +82 -0
- package/bundled/locales/zh-TW/ai/standards/anti-hallucination.ai.yaml +145 -0
- package/bundled/locales/zh-TW/ai/standards/changelog.ai.yaml +146 -0
- package/bundled/locales/zh-TW/ai/standards/checkin-standards.ai.yaml +170 -0
- package/bundled/locales/zh-TW/ai/standards/code-review.ai.yaml +148 -0
- package/bundled/locales/zh-TW/ai/standards/commit-message.ai.yaml +175 -0
- package/bundled/locales/zh-TW/ai/standards/documentation-structure.ai.yaml +124 -0
- package/bundled/locales/zh-TW/ai/standards/documentation-writing-standards.ai.yaml +190 -0
- package/bundled/locales/zh-TW/ai/standards/error-codes.ai.yaml +139 -0
- package/bundled/locales/zh-TW/ai/standards/git-workflow.ai.yaml +95 -0
- package/bundled/locales/zh-TW/ai/standards/logging.ai.yaml +128 -0
- package/bundled/locales/zh-TW/ai/standards/project-structure.ai.yaml +134 -0
- package/bundled/locales/zh-TW/ai/standards/spec-driven-development.ai.yaml +169 -0
- package/bundled/locales/zh-TW/ai/standards/test-completeness-dimensions.ai.yaml +220 -0
- package/bundled/locales/zh-TW/ai/standards/testing.ai.yaml +137 -0
- package/bundled/locales/zh-TW/ai/standards/versioning.ai.yaml +211 -0
- package/bundled/locales/zh-TW/core/ai-instruction-standards.md +213 -0
- package/bundled/locales/zh-TW/core/anti-hallucination.md +691 -0
- package/bundled/locales/zh-TW/core/changelog-standards.md +564 -0
- package/bundled/locales/zh-TW/core/checkin-standards.md +943 -0
- package/bundled/locales/zh-TW/core/code-review-checklist.md +693 -0
- package/bundled/locales/zh-TW/core/commit-message-guide.md +809 -0
- package/bundled/locales/zh-TW/core/documentation-structure.md +1125 -0
- package/bundled/locales/zh-TW/core/documentation-writing-standards.md +495 -0
- package/bundled/locales/zh-TW/core/error-code-standards.md +384 -0
- package/bundled/locales/zh-TW/core/git-workflow.md +860 -0
- package/bundled/locales/zh-TW/core/logging-standards.md +325 -0
- package/bundled/locales/zh-TW/core/project-structure.md +362 -0
- package/bundled/locales/zh-TW/core/refactoring-standards.md +642 -0
- package/bundled/locales/zh-TW/core/spec-driven-development.md +215 -0
- package/bundled/locales/zh-TW/core/test-completeness-dimensions.md +544 -0
- package/bundled/locales/zh-TW/core/test-driven-development.md +1004 -0
- package/bundled/locales/zh-TW/core/testing-standards.md +2158 -0
- package/bundled/locales/zh-TW/core/versioning.md +909 -0
- package/bundled/locales/zh-TW/docs/AI-AGENT-ROADMAP.md +303 -0
- package/bundled/locales/zh-TW/docs/CLI-INIT-OPTIONS.md +990 -0
- package/bundled/locales/zh-TW/docs/OPERATION-WORKFLOW.md +1064 -0
- package/bundled/locales/zh-TW/docs/USAGE-MODES-COMPARISON.md +333 -0
- package/bundled/locales/zh-TW/docs/WINDOWS-GUIDE.md +215 -0
- package/bundled/locales/zh-TW/integrations/codex/AGENTS.md +115 -0
- package/bundled/locales/zh-TW/integrations/codex/README.md +113 -0
- package/bundled/locales/zh-TW/integrations/gemini-cli/GEMINI.md +102 -0
- package/bundled/locales/zh-TW/integrations/gemini-cli/README.md +140 -0
- package/bundled/locales/zh-TW/integrations/github-copilot/COPILOT-CHAT-REFERENCE.md +269 -0
- package/bundled/locales/zh-TW/integrations/github-copilot/README.md +167 -0
- package/bundled/locales/zh-TW/integrations/github-copilot/copilot-instructions.md +263 -0
- package/bundled/locales/zh-TW/integrations/github-copilot/skills-mapping.md +192 -0
- package/bundled/locales/zh-TW/integrations/google-antigravity/INSTRUCTIONS.md +61 -0
- package/bundled/locales/zh-TW/integrations/google-antigravity/README.md +84 -0
- package/bundled/locales/zh-TW/integrations/opencode/AGENTS.md +111 -0
- package/bundled/locales/zh-TW/integrations/opencode/README.md +176 -0
- package/bundled/locales/zh-TW/integrations/opencode/skills-mapping.md +396 -0
- package/bundled/locales/zh-TW/integrations/openspec/AGENTS.md +301 -0
- package/bundled/locales/zh-TW/integrations/openspec/README.md +43 -0
- package/bundled/locales/zh-TW/integrations/spec-kit/AGENTS.md +184 -0
- package/bundled/locales/zh-TW/integrations/spec-kit/README.md +43 -0
- package/bundled/locales/zh-TW/options/commit-message/bilingual.md +161 -0
- package/bundled/locales/zh-TW/options/commit-message/english.md +137 -0
- package/bundled/locales/zh-TW/options/commit-message/traditional-chinese.md +162 -0
- package/bundled/locales/zh-TW/options/git-workflow/gitflow.md +147 -0
- package/bundled/locales/zh-TW/options/git-workflow/github-flow.md +124 -0
- package/bundled/locales/zh-TW/options/git-workflow/merge-commit.md +124 -0
- package/bundled/locales/zh-TW/options/git-workflow/rebase-ff.md +160 -0
- package/bundled/locales/zh-TW/options/git-workflow/squash-merge.md +117 -0
- package/bundled/locales/zh-TW/options/git-workflow/trunk-based.md +125 -0
- package/bundled/locales/zh-TW/options/project-structure/dotnet.md +183 -0
- package/bundled/locales/zh-TW/options/project-structure/go.md +226 -0
- package/bundled/locales/zh-TW/options/project-structure/java.md +213 -0
- package/bundled/locales/zh-TW/options/project-structure/nodejs.md +185 -0
- package/bundled/locales/zh-TW/options/project-structure/python.md +229 -0
- package/bundled/locales/zh-TW/options/testing/e2e-testing.md +207 -0
- package/bundled/locales/zh-TW/options/testing/integration-testing.md +230 -0
- package/bundled/locales/zh-TW/options/testing/system-testing.md +183 -0
- package/bundled/locales/zh-TW/options/testing/unit-testing.md +165 -0
- package/bundled/locales/zh-TW/skills/INTEGRATION-GUIDE.md +218 -0
- package/bundled/locales/zh-TW/skills/README.md +132 -0
- package/bundled/locales/zh-TW/skills/_shared/README.md +68 -0
- package/bundled/locales/zh-TW/skills/claude-code/CONTRIBUTING.template.md +151 -0
- package/bundled/locales/zh-TW/skills/claude-code/README.md +174 -0
- package/bundled/locales/zh-TW/skills/claude-code/ai-collaboration-standards/SKILL.md +175 -0
- package/bundled/locales/zh-TW/skills/claude-code/ai-collaboration-standards/anti-hallucination.md +223 -0
- package/bundled/locales/zh-TW/skills/claude-code/ai-collaboration-standards/certainty-labels.md +132 -0
- package/bundled/locales/zh-TW/skills/claude-code/changelog-guide/SKILL.md +237 -0
- package/bundled/locales/zh-TW/skills/claude-code/checkin-assistant/SKILL.md +407 -0
- package/bundled/locales/zh-TW/skills/claude-code/code-review-assistant/SKILL.md +154 -0
- package/bundled/locales/zh-TW/skills/claude-code/code-review-assistant/checkin-checklist.md +257 -0
- package/bundled/locales/zh-TW/skills/claude-code/code-review-assistant/review-checklist.md +246 -0
- package/bundled/locales/zh-TW/skills/claude-code/commands/bdd.md +142 -0
- package/bundled/locales/zh-TW/skills/claude-code/commands/methodology.md +274 -0
- package/bundled/locales/zh-TW/skills/claude-code/commit-standards/SKILL.md +191 -0
- package/bundled/locales/zh-TW/skills/claude-code/commit-standards/conventional-commits.md +264 -0
- package/bundled/locales/zh-TW/skills/claude-code/commit-standards/language-options.md +172 -0
- package/bundled/locales/zh-TW/skills/claude-code/documentation-guide/SKILL.md +421 -0
- package/bundled/locales/zh-TW/skills/claude-code/documentation-guide/documentation-structure.md +357 -0
- package/bundled/locales/zh-TW/skills/claude-code/documentation-guide/readme-template.md +412 -0
- package/bundled/locales/zh-TW/skills/claude-code/error-code-guide/SKILL.md +269 -0
- package/bundled/locales/zh-TW/skills/claude-code/git-workflow-guide/SKILL.md +218 -0
- package/bundled/locales/zh-TW/skills/claude-code/git-workflow-guide/branch-naming.md +220 -0
- package/bundled/locales/zh-TW/skills/claude-code/git-workflow-guide/git-workflow.md +321 -0
- package/bundled/locales/zh-TW/skills/claude-code/logging-guide/SKILL.md +285 -0
- package/bundled/locales/zh-TW/skills/claude-code/methodology-system/SKILL.md +131 -0
- package/bundled/locales/zh-TW/skills/claude-code/methodology-system/create-methodology.md +350 -0
- package/bundled/locales/zh-TW/skills/claude-code/methodology-system/runtime.md +279 -0
- package/bundled/locales/zh-TW/skills/claude-code/project-structure-guide/SKILL.md +143 -0
- package/bundled/locales/zh-TW/skills/claude-code/project-structure-guide/language-patterns.md +271 -0
- package/bundled/locales/zh-TW/skills/claude-code/refactoring-assistant/SKILL.md +162 -0
- package/bundled/locales/zh-TW/skills/claude-code/release-standards/SKILL.md +191 -0
- package/bundled/locales/zh-TW/skills/claude-code/release-standards/changelog-format.md +247 -0
- package/bundled/locales/zh-TW/skills/claude-code/release-standards/release-workflow.md +345 -0
- package/bundled/locales/zh-TW/skills/claude-code/release-standards/semantic-versioning.md +250 -0
- package/bundled/locales/zh-TW/skills/claude-code/requirement-assistant/SKILL.md +227 -0
- package/bundled/locales/zh-TW/skills/claude-code/requirement-assistant/requirement-checklist.md +325 -0
- package/bundled/locales/zh-TW/skills/claude-code/requirement-assistant/requirement-writing.md +399 -0
- package/bundled/locales/zh-TW/skills/claude-code/spec-driven-dev/SKILL.md +243 -0
- package/bundled/locales/zh-TW/skills/claude-code/tdd-assistant/SKILL.md +332 -0
- package/bundled/locales/zh-TW/skills/claude-code/tdd-assistant/language-examples.md +639 -0
- package/bundled/locales/zh-TW/skills/claude-code/tdd-assistant/tdd-workflow.md +486 -0
- package/bundled/locales/zh-TW/skills/claude-code/test-coverage-assistant/SKILL.md +282 -0
- package/bundled/locales/zh-TW/skills/claude-code/testing-guide/SKILL.md +234 -0
- package/bundled/locales/zh-TW/skills/claude-code/testing-guide/testing-pyramid.md +448 -0
- package/bundled/locales/zh-TW/skills/cline/README.md +58 -0
- package/bundled/locales/zh-TW/skills/copilot/README.md +61 -0
- package/bundled/locales/zh-TW/skills/copilot/copilot-instructions.md +79 -0
- package/bundled/locales/zh-TW/skills/cursor/README.md +58 -0
- package/bundled/locales/zh-TW/skills/windsurf/README.md +59 -0
- package/bundled/skills/claude-code/CONTRIBUTING.template.md +141 -0
- package/bundled/skills/claude-code/README.md +196 -0
- package/bundled/skills/claude-code/ai/standards/checkin.ai.yaml +21 -0
- package/bundled/skills/claude-code/ai/standards/commit.ai.yaml +20 -0
- package/bundled/skills/claude-code/ai/standards/refactoring.ai.yaml +34 -0
- package/bundled/skills/claude-code/ai/standards/testing.ai.yaml +41 -0
- package/bundled/skills/claude-code/ai-collaboration-standards/SKILL.md +175 -0
- package/bundled/skills/claude-code/ai-collaboration-standards/anti-hallucination.md +215 -0
- package/bundled/skills/claude-code/ai-collaboration-standards/certainty-labels.md +124 -0
- package/bundled/skills/claude-code/changelog-guide/SKILL.md +232 -0
- package/bundled/skills/claude-code/checkin-assistant/SKILL.md +402 -0
- package/bundled/skills/claude-code/code-review-assistant/SKILL.md +220 -0
- package/bundled/skills/claude-code/code-review-assistant/checkin-checklist.md +249 -0
- package/bundled/skills/claude-code/code-review-assistant/review-checklist.md +238 -0
- package/bundled/skills/claude-code/commands/README.md +78 -0
- package/bundled/skills/claude-code/commands/bdd.md +142 -0
- package/bundled/skills/claude-code/commands/changelog.md +57 -0
- package/bundled/skills/claude-code/commands/check.md +91 -0
- package/bundled/skills/claude-code/commands/commit.md +48 -0
- package/bundled/skills/claude-code/commands/config.md +97 -0
- package/bundled/skills/claude-code/commands/coverage.md +58 -0
- package/bundled/skills/claude-code/commands/docs.md +75 -0
- package/bundled/skills/claude-code/commands/init.md +88 -0
- package/bundled/skills/claude-code/commands/methodology.md +268 -0
- package/bundled/skills/claude-code/commands/release.md +50 -0
- package/bundled/skills/claude-code/commands/requirement.md +54 -0
- package/bundled/skills/claude-code/commands/review.md +50 -0
- package/bundled/skills/claude-code/commands/spec.md +69 -0
- package/bundled/skills/claude-code/commands/tdd.md +86 -0
- package/bundled/skills/claude-code/commands/update.md +122 -0
- package/bundled/skills/claude-code/commit-standards/SKILL.md +249 -0
- package/bundled/skills/claude-code/commit-standards/conventional-commits.md +256 -0
- package/bundled/skills/claude-code/commit-standards/language-options.md +164 -0
- package/bundled/skills/claude-code/documentation-guide/SKILL.md +416 -0
- package/bundled/skills/claude-code/documentation-guide/documentation-structure.md +349 -0
- package/bundled/skills/claude-code/documentation-guide/readme-template.md +404 -0
- package/bundled/skills/claude-code/error-code-guide/SKILL.md +264 -0
- package/bundled/skills/claude-code/git-workflow-guide/SKILL.md +226 -0
- package/bundled/skills/claude-code/git-workflow-guide/branch-naming.md +212 -0
- package/bundled/skills/claude-code/git-workflow-guide/git-workflow.md +313 -0
- package/bundled/skills/claude-code/logging-guide/SKILL.md +280 -0
- package/bundled/skills/claude-code/methodology-system/SKILL.md +215 -0
- package/bundled/skills/claude-code/methodology-system/create-methodology.md +450 -0
- package/bundled/skills/claude-code/methodology-system/runtime.md +271 -0
- package/bundled/skills/claude-code/project-structure-guide/SKILL.md +143 -0
- package/bundled/skills/claude-code/project-structure-guide/language-patterns.md +263 -0
- package/bundled/skills/claude-code/refactoring-assistant/SKILL.md +205 -0
- package/bundled/skills/claude-code/release-standards/SKILL.md +191 -0
- package/bundled/skills/claude-code/release-standards/changelog-format.md +239 -0
- package/bundled/skills/claude-code/release-standards/release-workflow.md +337 -0
- package/bundled/skills/claude-code/release-standards/semantic-versioning.md +242 -0
- package/bundled/skills/claude-code/requirement-assistant/SKILL.md +222 -0
- package/bundled/skills/claude-code/requirement-assistant/requirement-checklist.md +317 -0
- package/bundled/skills/claude-code/requirement-assistant/requirement-writing.md +391 -0
- package/bundled/skills/claude-code/spec-driven-dev/SKILL.md +238 -0
- package/bundled/skills/claude-code/tdd-assistant/SKILL.md +384 -0
- package/bundled/skills/claude-code/tdd-assistant/language-examples.md +1276 -0
- package/bundled/skills/claude-code/tdd-assistant/tdd-workflow.md +659 -0
- package/bundled/skills/claude-code/test-coverage-assistant/SKILL.md +277 -0
- package/bundled/skills/claude-code/testing-guide/SKILL.md +317 -0
- package/bundled/skills/claude-code/testing-guide/testing-pyramid.md +440 -0
- package/package.json +4 -2
- package/src/commands/check.js +38 -6
- package/src/commands/init.js +20 -6
- package/src/commands/list.js +7 -2
- package/src/commands/skills.js +0 -2
- package/src/commands/update.js +271 -0
- package/src/i18n/messages.js +161 -11
- package/src/utils/copier.js +63 -10
- package/src/utils/skills-installer.js +47 -11
- package/standards-registry.json +6 -3
|
@@ -0,0 +1,137 @@
|
|
|
1
|
+
# 測試標準 - AI 優化版
|
|
2
|
+
# 來源: core/testing-standards.md
|
|
3
|
+
|
|
4
|
+
id: testing
|
|
5
|
+
meta:
|
|
6
|
+
version: "1.3.0"
|
|
7
|
+
updated: "2025-12-30"
|
|
8
|
+
source: core/testing-standards.md
|
|
9
|
+
description: 測試金字塔與建議的覆蓋率比例,支援框架選項
|
|
10
|
+
language: zh-TW
|
|
11
|
+
|
|
12
|
+
# 框架選擇 - 根據專案需求選擇
|
|
13
|
+
# 參考來源: ISTQB Glossary v4.0, Martin Fowler's Testing Pyramid
|
|
14
|
+
framework_options:
|
|
15
|
+
decision_point: 根據專案類型選擇測試框架
|
|
16
|
+
choices:
|
|
17
|
+
- id: istqb-framework
|
|
18
|
+
file: options/testing/istqb-framework.ai.yaml
|
|
19
|
+
best_for: 企業專案、認證需求、正式 QA 流程
|
|
20
|
+
- id: industry-pyramid
|
|
21
|
+
file: options/testing/industry-pyramid.ai.yaml
|
|
22
|
+
best_for: 敏捷開發、CI/CD 優化、快速迭代
|
|
23
|
+
|
|
24
|
+
# 預設金字塔 (業界標準 - 可由框架選擇覆蓋)
|
|
25
|
+
pyramid:
|
|
26
|
+
ratio: "70/20/10"
|
|
27
|
+
note: "業界標準比例。ISTQB 框架使用 4 層但無固定比例。"
|
|
28
|
+
levels:
|
|
29
|
+
- name: 單元測試 (UT)
|
|
30
|
+
percentage: 70
|
|
31
|
+
scope: 單一函式/方法
|
|
32
|
+
speed: 非常快 (<100ms)
|
|
33
|
+
- name: 整合測試 (IT/SIT)
|
|
34
|
+
percentage: 20
|
|
35
|
+
scope: 多個元件
|
|
36
|
+
speed: 快速 (<1s)
|
|
37
|
+
note: "IT (敏捷/DevOps) 或 SIT (企業/ISTQB) - 兩者都指整合測試"
|
|
38
|
+
- name: 端對端測試 (E2E)
|
|
39
|
+
percentage: 10
|
|
40
|
+
scope: 使用者流程/系統測試
|
|
41
|
+
speed: 較慢 (>10s)
|
|
42
|
+
|
|
43
|
+
options:
|
|
44
|
+
testing_framework:
|
|
45
|
+
description: 選擇測試框架方法
|
|
46
|
+
multiSelect: false
|
|
47
|
+
choices:
|
|
48
|
+
- id: istqb-framework
|
|
49
|
+
file: options/testing/istqb-framework.ai.yaml
|
|
50
|
+
- id: industry-pyramid
|
|
51
|
+
file: options/testing/industry-pyramid.ai.yaml
|
|
52
|
+
test_level:
|
|
53
|
+
description: 選擇要實施的測試層級
|
|
54
|
+
multiSelect: true
|
|
55
|
+
choices:
|
|
56
|
+
- id: unit-testing
|
|
57
|
+
file: options/testing/unit-testing.ai.yaml
|
|
58
|
+
- id: integration-testing
|
|
59
|
+
file: options/testing/integration-testing.ai.yaml
|
|
60
|
+
- id: system-testing
|
|
61
|
+
file: options/testing/system-testing.ai.yaml
|
|
62
|
+
- id: e2e-testing
|
|
63
|
+
file: options/testing/e2e-testing.ai.yaml
|
|
64
|
+
- id: security-testing
|
|
65
|
+
file: options/testing/security-testing.ai.yaml
|
|
66
|
+
best_for: 處理敏感資料的應用程式、安全關鍵系統
|
|
67
|
+
- id: performance-testing
|
|
68
|
+
file: options/testing/performance-testing.ai.yaml
|
|
69
|
+
best_for: 高流量應用程式、即時系統、API
|
|
70
|
+
- id: contract-testing
|
|
71
|
+
file: options/testing/contract-testing.ai.yaml
|
|
72
|
+
best_for: 微服務、API 整合、分散式系統
|
|
73
|
+
|
|
74
|
+
rules:
|
|
75
|
+
- id: follow-pyramid
|
|
76
|
+
trigger: 規劃測試策略時
|
|
77
|
+
instruction: 遵循 70/20/7/3 的單元/整合/系統/端對端比例
|
|
78
|
+
priority: required
|
|
79
|
+
|
|
80
|
+
- id: first-principles
|
|
81
|
+
trigger: 撰寫測試時
|
|
82
|
+
instruction: 遵循 FIRST 原則(快速、獨立、可重複、自我驗證、及時)
|
|
83
|
+
priority: required
|
|
84
|
+
|
|
85
|
+
- id: arrange-act-assert
|
|
86
|
+
trigger: 組織測試結構時
|
|
87
|
+
instruction: 使用 Arrange-Act-Assert 模式
|
|
88
|
+
priority: required
|
|
89
|
+
|
|
90
|
+
- id: meaningful-names
|
|
91
|
+
trigger: 命名測試時
|
|
92
|
+
instruction: 使用描述性的測試名稱,說明測試內容
|
|
93
|
+
priority: required
|
|
94
|
+
examples:
|
|
95
|
+
good:
|
|
96
|
+
- "should_return_user_when_valid_id_provided"
|
|
97
|
+
- "test_login_fails_with_invalid_credentials"
|
|
98
|
+
bad:
|
|
99
|
+
- "test1"
|
|
100
|
+
- "testLogin"
|
|
101
|
+
|
|
102
|
+
- id: test-boundaries
|
|
103
|
+
trigger: 選擇測試內容時
|
|
104
|
+
instruction: 專注於邊界條件和邊緣案例
|
|
105
|
+
priority: recommended
|
|
106
|
+
|
|
107
|
+
- id: avoid-test-doubles-overuse
|
|
108
|
+
trigger: 使用 mocks/stubs 時
|
|
109
|
+
instruction: 謹慎使用測試替身;當速度足夠快時,優先使用真實實作
|
|
110
|
+
priority: recommended
|
|
111
|
+
|
|
112
|
+
quick_reference:
|
|
113
|
+
test_pyramid:
|
|
114
|
+
columns: [層級, 百分比, 範圍, 速度]
|
|
115
|
+
rows:
|
|
116
|
+
- [單元, 70%, 單一函式, <100ms]
|
|
117
|
+
- [整合, 20%, 多個元件, <1s]
|
|
118
|
+
- [系統, 7%, 完整系統, <10s]
|
|
119
|
+
- [端對端, 3%, 使用者流程, ">10s"]
|
|
120
|
+
|
|
121
|
+
first_principles:
|
|
122
|
+
columns: [原則, 說明]
|
|
123
|
+
rows:
|
|
124
|
+
- [快速 (Fast), 測試執行迅速]
|
|
125
|
+
- [獨立 (Independent), 測試之間無相依性]
|
|
126
|
+
- [可重複 (Repeatable), 每次執行結果相同]
|
|
127
|
+
- [自我驗證 (Self-validating), 通過/失敗無需人工檢查]
|
|
128
|
+
- [及時 (Timely), 與程式碼同步撰寫]
|
|
129
|
+
|
|
130
|
+
test_doubles:
|
|
131
|
+
columns: [類型, 用途, 使用時機]
|
|
132
|
+
rows:
|
|
133
|
+
- [Stub, 回傳預設值, 簡單相依性]
|
|
134
|
+
- [Mock, 驗證互動, 複雜相依性]
|
|
135
|
+
- [Fake, 簡化實作, 資料庫/外部服務]
|
|
136
|
+
- [Spy, 記錄呼叫, 驗證行為]
|
|
137
|
+
- [Dummy, 填充參數, 未使用的參數]
|
|
@@ -0,0 +1,211 @@
|
|
|
1
|
+
# 語意化版本標準 - AI 優化版
|
|
2
|
+
# 來源: core/versioning.md
|
|
3
|
+
|
|
4
|
+
id: versioning
|
|
5
|
+
meta:
|
|
6
|
+
version: "1.2.0"
|
|
7
|
+
updated: "2025-12-30"
|
|
8
|
+
source: core/versioning.md
|
|
9
|
+
description: 軟體發布的語意化版本 (SemVer)
|
|
10
|
+
language: zh-TW
|
|
11
|
+
|
|
12
|
+
format:
|
|
13
|
+
template: "MAJOR.MINOR.PATCH[-PRERELEASE][+BUILD]"
|
|
14
|
+
examples:
|
|
15
|
+
- "2.3.1"
|
|
16
|
+
- "1.0.0-alpha.1"
|
|
17
|
+
- "3.2.0-beta.2+20250112"
|
|
18
|
+
|
|
19
|
+
components:
|
|
20
|
+
major:
|
|
21
|
+
purpose: 破壞性變更
|
|
22
|
+
when_to_increment:
|
|
23
|
+
- 不相容的 API 變更
|
|
24
|
+
- 移除已棄用功能
|
|
25
|
+
- 重大架構變更
|
|
26
|
+
guidelines:
|
|
27
|
+
- 重設 MINOR 和 PATCH 為 0
|
|
28
|
+
- 記錄遷移指南
|
|
29
|
+
- 在前一個 MINOR 版本提供棄用警告
|
|
30
|
+
|
|
31
|
+
minor:
|
|
32
|
+
purpose: 新功能
|
|
33
|
+
when_to_increment:
|
|
34
|
+
- 新增向後相容的功能
|
|
35
|
+
- 棄用功能(非移除)
|
|
36
|
+
- 重大內部改進
|
|
37
|
+
guidelines:
|
|
38
|
+
- 重設 PATCH 為 0
|
|
39
|
+
- 既有功能不變
|
|
40
|
+
- 新功能是選擇性的
|
|
41
|
+
|
|
42
|
+
patch:
|
|
43
|
+
purpose: Bug 修正
|
|
44
|
+
when_to_increment:
|
|
45
|
+
- Bug 修正(無新功能)
|
|
46
|
+
- 安全修補
|
|
47
|
+
- 文件更正
|
|
48
|
+
- 內部重構(無 API 變更)
|
|
49
|
+
guidelines:
|
|
50
|
+
- 無新功能
|
|
51
|
+
- 無 API 變更
|
|
52
|
+
- 可以安全立即更新
|
|
53
|
+
|
|
54
|
+
prerelease:
|
|
55
|
+
identifiers:
|
|
56
|
+
- id: alpha
|
|
57
|
+
purpose: 早期測試
|
|
58
|
+
stability: 不穩定
|
|
59
|
+
audience: 內部團隊
|
|
60
|
+
|
|
61
|
+
- id: beta
|
|
62
|
+
purpose: 功能完整
|
|
63
|
+
stability: 大致穩定
|
|
64
|
+
audience: 早期採用者
|
|
65
|
+
|
|
66
|
+
- id: rc
|
|
67
|
+
purpose: 最終測試(發布候選)
|
|
68
|
+
stability: 穩定
|
|
69
|
+
audience: Beta 測試者
|
|
70
|
+
|
|
71
|
+
ordering: "alpha < beta < rc < stable"
|
|
72
|
+
|
|
73
|
+
initial_development:
|
|
74
|
+
version_0:
|
|
75
|
+
description: 主版本 0 表示開發階段
|
|
76
|
+
guidelines:
|
|
77
|
+
- API 可能頻繁變更
|
|
78
|
+
- MINOR 版本允許破壞性變更
|
|
79
|
+
- API 穩定時升至 1.0.0
|
|
80
|
+
|
|
81
|
+
deprecation:
|
|
82
|
+
timeline:
|
|
83
|
+
internal_api: 1 個 minor 版本
|
|
84
|
+
partner_api: 2 個 minor 版本 + 3 個月
|
|
85
|
+
public_api: 2 個 minor 版本 + 6 個月
|
|
86
|
+
critical_infrastructure: 至少 1 年
|
|
87
|
+
|
|
88
|
+
backward_compatibility:
|
|
89
|
+
breaking_changes:
|
|
90
|
+
- 移除公開 API 端點
|
|
91
|
+
- 移除必要請求欄位
|
|
92
|
+
- 新增必要請求欄位
|
|
93
|
+
- 變更回應欄位類型
|
|
94
|
+
- 變更錯誤碼含義
|
|
95
|
+
- 移除使用者依賴的回應欄位
|
|
96
|
+
|
|
97
|
+
safe_changes:
|
|
98
|
+
- 新增選用請求欄位
|
|
99
|
+
- 新增回應欄位
|
|
100
|
+
- 新增端點
|
|
101
|
+
- 新增錯誤碼
|
|
102
|
+
- 改善錯誤訊息
|
|
103
|
+
- 效能改進
|
|
104
|
+
|
|
105
|
+
api_versioning_strategies:
|
|
106
|
+
- strategy: URL 路徑
|
|
107
|
+
format: "/api/v1/users"
|
|
108
|
+
pros: 清楚、易於路由
|
|
109
|
+
cons: URL 污染
|
|
110
|
+
recommended: true
|
|
111
|
+
|
|
112
|
+
- strategy: 查詢參數
|
|
113
|
+
format: "/api/users?version=1"
|
|
114
|
+
pros: 選用版本控制
|
|
115
|
+
cons: 快取問題
|
|
116
|
+
|
|
117
|
+
- strategy: Header
|
|
118
|
+
format: "Accept: application/vnd.api.v1+json"
|
|
119
|
+
pros: 乾淨的 URL
|
|
120
|
+
cons: 較不可見
|
|
121
|
+
|
|
122
|
+
release_process:
|
|
123
|
+
phases:
|
|
124
|
+
- phase: 1
|
|
125
|
+
name: 發布前診斷
|
|
126
|
+
mandatory: true
|
|
127
|
+
check_items:
|
|
128
|
+
- 系統工具版本
|
|
129
|
+
- 必要驅動程式
|
|
130
|
+
- 磁碟空間
|
|
131
|
+
- 資料庫連線
|
|
132
|
+
- 應用程式版本
|
|
133
|
+
- 設定完整性
|
|
134
|
+
|
|
135
|
+
- phase: 2
|
|
136
|
+
name: 環境準備
|
|
137
|
+
purpose: 安裝缺少的工具和驅動程式
|
|
138
|
+
|
|
139
|
+
- phase: 3
|
|
140
|
+
name: 套件產生
|
|
141
|
+
naming: "{PROJECT}-upgrade-v{VERSION}-{DATE}.tar.gz"
|
|
142
|
+
|
|
143
|
+
- phase: 4
|
|
144
|
+
name: 部署執行
|
|
145
|
+
steps:
|
|
146
|
+
- 上傳升級套件
|
|
147
|
+
- 解壓套件
|
|
148
|
+
- 試運行測試(強烈建議)
|
|
149
|
+
- 實際升級
|
|
150
|
+
|
|
151
|
+
- phase: 5
|
|
152
|
+
name: 發布後驗證
|
|
153
|
+
check_items:
|
|
154
|
+
- 服務正常運作
|
|
155
|
+
- API 回傳正確版本
|
|
156
|
+
- 日誌無致命錯誤
|
|
157
|
+
- 功能驗證通過
|
|
158
|
+
|
|
159
|
+
rules:
|
|
160
|
+
- id: semver-compliance
|
|
161
|
+
trigger: 發布新版本時
|
|
162
|
+
instruction: 嚴格遵循語意化版本格式
|
|
163
|
+
priority: required
|
|
164
|
+
|
|
165
|
+
- id: deprecation-warning
|
|
166
|
+
trigger: 規劃破壞性變更時
|
|
167
|
+
instruction: 在移除前 N-1 版本加入棄用警告
|
|
168
|
+
priority: required
|
|
169
|
+
|
|
170
|
+
- id: migration-guide
|
|
171
|
+
trigger: 發布 MAJOR 版本時
|
|
172
|
+
instruction: 記錄遷移指南,附前後對照範例
|
|
173
|
+
priority: required
|
|
174
|
+
|
|
175
|
+
- id: changelog-update
|
|
176
|
+
trigger: 發布任何版本時
|
|
177
|
+
instruction: 更新 CHANGELOG.md 記錄所有重要變更
|
|
178
|
+
priority: required
|
|
179
|
+
|
|
180
|
+
- id: pre-release-diagnosis
|
|
181
|
+
trigger: 開始發布流程時
|
|
182
|
+
instruction: 不得跳過診斷階段
|
|
183
|
+
priority: required
|
|
184
|
+
|
|
185
|
+
- id: dry-run-test
|
|
186
|
+
trigger: 部署升級時
|
|
187
|
+
instruction: 不得跳過試運行測試
|
|
188
|
+
priority: required
|
|
189
|
+
|
|
190
|
+
quick_reference:
|
|
191
|
+
version_components:
|
|
192
|
+
columns: [組成, 用途, 重設]
|
|
193
|
+
rows:
|
|
194
|
+
- [MAJOR, 破壞性變更, "MINOR=0, PATCH=0"]
|
|
195
|
+
- [MINOR, 新功能, "PATCH=0"]
|
|
196
|
+
- [PATCH, Bug 修正, 無]
|
|
197
|
+
|
|
198
|
+
prerelease_order:
|
|
199
|
+
columns: [識別碼, 穩定度, 受眾]
|
|
200
|
+
rows:
|
|
201
|
+
- [alpha, 不穩定, 內部團隊]
|
|
202
|
+
- [beta, 大致穩定, 早期採用者]
|
|
203
|
+
- [rc, 穩定, Beta 測試者]
|
|
204
|
+
|
|
205
|
+
deprecation_periods:
|
|
206
|
+
columns: [API 類型, 最短期間]
|
|
207
|
+
rows:
|
|
208
|
+
- [內部 API, 1 個 minor 版本]
|
|
209
|
+
- [合作夥伴 API, 2 個 minor + 3 個月]
|
|
210
|
+
- [公開 API, 2 個 minor + 6 個月]
|
|
211
|
+
- [關鍵基礎設施, 1 年]
|
|
@@ -0,0 +1,213 @@
|
|
|
1
|
+
---
|
|
2
|
+
source: core/ai-instruction-standards.md
|
|
3
|
+
source_version: 1.0.0
|
|
4
|
+
translation_version: 1.0.0
|
|
5
|
+
last_synced: 2026-01-14
|
|
6
|
+
status: current
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# AI 指令檔案規範
|
|
10
|
+
|
|
11
|
+
> **語言**: [English](../../../core/ai-instruction-standards.md) | 繁體中文
|
|
12
|
+
|
|
13
|
+
**版本**: 1.0.0
|
|
14
|
+
**最後更新**: 2026-01-14
|
|
15
|
+
**適用範圍**: 所有使用 AI 編碼助手的專案
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## 目的
|
|
20
|
+
|
|
21
|
+
本規範定義建立和維護 AI 指令檔案(又稱「系統提示詞檔」)的最佳實踐。這些檔案引導 AI 助手理解專案特定的慣例、標準和工作流程。
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
## 支援的 AI 工具
|
|
26
|
+
|
|
27
|
+
| AI 工具 | 指令檔案 | 格式 |
|
|
28
|
+
|---------|---------|------|
|
|
29
|
+
| Claude Code | `CLAUDE.md` | Markdown |
|
|
30
|
+
| Cursor | `.cursorrules` | Markdown |
|
|
31
|
+
| Windsurf | `.windsurfrules` | Markdown |
|
|
32
|
+
| Cline | `.clinerules` | Markdown |
|
|
33
|
+
| GitHub Copilot | `.github/copilot-instructions.md` | Markdown |
|
|
34
|
+
| OpenCode | `.opencode/instructions.md` | Markdown |
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
## 核心原則:通用與專用分離
|
|
39
|
+
|
|
40
|
+
### 為什麼要分離?
|
|
41
|
+
|
|
42
|
+
AI 指令檔案通常混合兩種類型的內容:
|
|
43
|
+
1. **通用規則**:適用於任何專案
|
|
44
|
+
2. **專案專用配置**:專屬於你的專案
|
|
45
|
+
|
|
46
|
+
分離這些內容可以改善:
|
|
47
|
+
- **可攜性**:通用區段可在專案間重複使用
|
|
48
|
+
- **可維護性**:更容易更新而不會意外「洩漏」
|
|
49
|
+
- **清晰性**:使用者知道採用標準時需要自訂哪些部分
|
|
50
|
+
|
|
51
|
+
---
|
|
52
|
+
|
|
53
|
+
## 檔案結構
|
|
54
|
+
|
|
55
|
+
### 建議的佈局
|
|
56
|
+
|
|
57
|
+
```markdown
|
|
58
|
+
# [專案名稱] - AI 指令
|
|
59
|
+
|
|
60
|
+
## 通用標準
|
|
61
|
+
<!-- 適用於任何專案的規則 -->
|
|
62
|
+
- Commit 訊息格式
|
|
63
|
+
- 程式碼審查清單
|
|
64
|
+
- 測試標準
|
|
65
|
+
- 反幻覺規則
|
|
66
|
+
|
|
67
|
+
---
|
|
68
|
+
|
|
69
|
+
## 專案專用配置
|
|
70
|
+
<!-- 專屬於本專案 - 採用時需自訂 -->
|
|
71
|
+
|
|
72
|
+
### 技術棧
|
|
73
|
+
[你的技術在這裡]
|
|
74
|
+
|
|
75
|
+
### 快速指令
|
|
76
|
+
[你的建置/測試/部署指令]
|
|
77
|
+
|
|
78
|
+
### 檔案結構
|
|
79
|
+
[你的專案結構]
|
|
80
|
+
|
|
81
|
+
### 發布流程
|
|
82
|
+
[你的發布工作流程]
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
---
|
|
86
|
+
|
|
87
|
+
## 內容指南
|
|
88
|
+
|
|
89
|
+
### 通用內容(不要包含專案特定細節)
|
|
90
|
+
|
|
91
|
+
| 類別 | 範例 |
|
|
92
|
+
|------|------|
|
|
93
|
+
| **Commit 標準** | Conventional Commits 格式、訊息結構 |
|
|
94
|
+
| **程式碼審查** | 審查清單、註解前綴 |
|
|
95
|
+
| **測試** | 測試金字塔比例、命名慣例 |
|
|
96
|
+
| **AI 行為** | 反幻覺規則、來源標註 |
|
|
97
|
+
| **文件** | 寫作風格、結構指南 |
|
|
98
|
+
|
|
99
|
+
**在通用區段中避免:**
|
|
100
|
+
- 特定指令(例如:`npm test`、`pytest`)
|
|
101
|
+
- 硬編碼路徑(例如:`cli/src/`、`/var/www/`)
|
|
102
|
+
- 版本號(例如:`Node.js 18`、`Python 3.11`)
|
|
103
|
+
- 專案名稱和 URL
|
|
104
|
+
|
|
105
|
+
### 專案專用內容(明確標記這些區段)
|
|
106
|
+
|
|
107
|
+
| 類別 | 範例 |
|
|
108
|
+
|------|------|
|
|
109
|
+
| **技術棧** | 程式語言、框架、版本 |
|
|
110
|
+
| **指令** | 建置、測試、lint、部署指令 |
|
|
111
|
+
| **檔案結構** | 目錄佈局、關鍵檔案 |
|
|
112
|
+
| **發布流程** | 版本檔案、部署步驟 |
|
|
113
|
+
| **團隊慣例** | 語言偏好、命名模式 |
|
|
114
|
+
|
|
115
|
+
---
|
|
116
|
+
|
|
117
|
+
## 標記慣例
|
|
118
|
+
|
|
119
|
+
使用明確的標記來區分內容類型:
|
|
120
|
+
|
|
121
|
+
### 選項 A:區段標題
|
|
122
|
+
|
|
123
|
+
```markdown
|
|
124
|
+
## 通用標準
|
|
125
|
+
[通用內容]
|
|
126
|
+
|
|
127
|
+
## 專案專用配置
|
|
128
|
+
[專案專用內容]
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
### 選項 B:行內標記
|
|
132
|
+
|
|
133
|
+
```markdown
|
|
134
|
+
> ⚠️ **專案專用**:此區段包含專屬於本專案的配置。
|
|
135
|
+
|
|
136
|
+
### 技術棧
|
|
137
|
+
...
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
### 選項 C:註解標註
|
|
141
|
+
|
|
142
|
+
```markdown
|
|
143
|
+
<!-- 通用:以下適用於所有專案 -->
|
|
144
|
+
### Commit 訊息格式
|
|
145
|
+
...
|
|
146
|
+
|
|
147
|
+
<!-- 專案專用:為你的專案自訂 -->
|
|
148
|
+
### 快速指令
|
|
149
|
+
...
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
---
|
|
153
|
+
|
|
154
|
+
## 維護檢查清單
|
|
155
|
+
|
|
156
|
+
在提交 AI 指令檔案的變更之前:
|
|
157
|
+
|
|
158
|
+
- [ ] **通用區段**:無專案特定的路徑、指令或版本
|
|
159
|
+
- [ ] **專案專用區段**:已用標籤明確標記
|
|
160
|
+
- [ ] **交叉引用**:指向標準文件的連結正確
|
|
161
|
+
- [ ] **一致性**:格式與現有區段一致
|
|
162
|
+
|
|
163
|
+
### 洩漏檢測
|
|
164
|
+
|
|
165
|
+
執行此檢查以找出通用區段中可能的專案特定內容洩漏:
|
|
166
|
+
|
|
167
|
+
```bash
|
|
168
|
+
# 範例:在通用區段中找出硬編碼指令
|
|
169
|
+
grep -n "npm\|yarn\|pip\|cargo" CLAUDE.md | head -20
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
審查每個匹配項,確保它在專案專用區段中。
|
|
173
|
+
|
|
174
|
+
---
|
|
175
|
+
|
|
176
|
+
## 快速參考卡
|
|
177
|
+
|
|
178
|
+
### 通用 vs 專案專用
|
|
179
|
+
|
|
180
|
+
| 類型 | 包含 | 範例 |
|
|
181
|
+
|------|------|------|
|
|
182
|
+
| **通用** | 通用規則 | 「提交前執行測試」 |
|
|
183
|
+
| **專案專用** | 具體指令 | 「提交前執行 `npm test`」 |
|
|
184
|
+
|
|
185
|
+
### 區段標記
|
|
186
|
+
|
|
187
|
+
| 標記 | 含義 |
|
|
188
|
+
|------|------|
|
|
189
|
+
| `## 通用` | 適用於任何專案 |
|
|
190
|
+
| `## 專案專用` | 專屬於本專案 |
|
|
191
|
+
| `> ⚠️ 專案專用` | 特定區段的行內警告 |
|
|
192
|
+
|
|
193
|
+
---
|
|
194
|
+
|
|
195
|
+
## 相關標準
|
|
196
|
+
|
|
197
|
+
- [文件結構](documentation-structure.md)
|
|
198
|
+
- [文件寫作標準](documentation-writing-standards.md)
|
|
199
|
+
- [反幻覺指南](anti-hallucination.md)
|
|
200
|
+
|
|
201
|
+
---
|
|
202
|
+
|
|
203
|
+
## 版本歷史
|
|
204
|
+
|
|
205
|
+
| 版本 | 日期 | 變更 |
|
|
206
|
+
|------|------|------|
|
|
207
|
+
| 1.0.0 | 2026-01-14 | 初始發布 |
|
|
208
|
+
|
|
209
|
+
---
|
|
210
|
+
|
|
211
|
+
## 授權
|
|
212
|
+
|
|
213
|
+
本標準採用 [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) 發布。
|