容：開發(fā)者指南、LLM消費規(guī)則與CI校驗全解析)
如何給terraform-skill貢獻內(nèi)容開發(fā)者指南、LLM消費規(guī)則與CI校驗全解析【免費下載鏈接】terraform-skillTerraform OpenTofu Skill for AI Agents - testing, modules, CI/CD, and production patterns項目地址: https://gitcode.com/gh_mirrors/te/terraform-skillterraform-skill 是一個面向 AI 編碼代理的 Terraform / OpenTofu 最佳實踐技能包覆蓋測試框架、模塊開發(fā)、狀態(tài)管理、CI/CD 與安全掃描等生產(chǎn)模式。想給它貢獻內(nèi)容本文基于 CONTRIBUTING.md 與 CLAUDE.md 詳解完整貢獻流程從 Fork 倉庫到 PR 合并重點解析面向 LLM 的消費者規(guī)則、TDD 測試鐵律與 CI 校驗機制幫助你寫出能被順利合并的高質(zhì)量貢獻 5 步快速上手完成你的第一次 terraform-skill 貢獻貢獻流程與常規(guī)開源項目類似但門檻判斷更嚴格Fork 倉庫克隆倉庫到本地git clone https://gitcode.com/gh_mirrors/te/terraform-skill創(chuàng)建功能分支git checkout -b feature/your-topic按規(guī)范修改內(nèi)容下文詳述先測試再提交遵循 TDD 鐵律見下文提交 PR附帶測試證據(jù)??master分支受保護禁止直接推送所有變更必須通過 PR 合入。判斷你的內(nèi)容適不適合貢獻項目明確劃分了好貢獻與不合適的邊界? 歡迎? 不歡迎有社區(qū)共識的 Terraform/OpenTofu 最佳實踐缺乏共識的個人偏好新版本特性的針對性指引Provider 特定的資源細節(jié)應走 Terraform MCP 工具糾正過時或錯誤信息未經(jīng)驗證的變更更好的示例、模式、測試框架改進與 AI 模型已有知識重復的內(nèi)容內(nèi)容落在哪里項目有清晰的分工表詳見 CLAUDE.md#L187-L196決策框架與核心模式進 skills/terraform-skill/SKILL.md約 305 行軟上限目標 ~300 行詳細示例與模板進 skills/terraform-skill/references/ 目錄下的 8 個參考文件。LLM 消費規(guī)則全解析為什么文檔要為機器而寫這是 terraform-skill 貢獻指南中最特別的部分——這份文檔的第一讀者不是人而是檢索事實來回答問題的 LLM。所有對 SKILL.md 和 references/*.md 的修改都必須遵守 CLAUDE.md#L155-L171 中的 6 條強制規(guī)則違者 PR 會被直接拒收 決策表先行手冊在后一個主題有多種可行方案時先給決策表目標 | 選用 | 取舍再寫步驟絕不能把分支藏在正文末尾。砍掉人類腳手架before/after 對比、Why this matters 段落、教學式旁白——如果步驟里已經(jīng)寫了該做什么這類內(nèi)容就是冗余。散文壓縮成 ?/? 規(guī)則凡是以 You should...、Note that...、Keep in mind... 開頭的句子改寫為祈使句 ?/? 條目一條一個事實。每個制品都要掙得自己的 token代碼塊和表格必須包含正文中沒有的新事實只為完整性存在的內(nèi)容一律刪除。錨點穩(wěn)定性SKILL.md 通過#anchor鏈接到參考文件的具體小節(jié)重寫時必須保留頂層### Heading錨點。檢索優(yōu)先排序章節(jié)內(nèi)部按 LLM 需要的順序排列——決策表 → 默認流程 → 備選方案 → ?/? 規(guī)則。Token 預算每個參考小節(jié)目標 400 tokens約 1600 字符超過就拆分或壓縮。技巧包括細節(jié)下沉到 references漸進式披露、表格優(yōu)于散文、跨文件引用而非重復內(nèi)容。Frontmatter 要求SKILL.md 的門面修改 skills/terraform-skill/SKILL.md 時YAML frontmatter 有兩個必填字段CONTRIBUTING.md#L33-L66name技能名僅允許字母、數(shù)字、連字符description≤1024 字符必須以 Use when 開頭寫清楚何時使用觸發(fā)場景與癥狀而不是這個技能做什么metadata.version由發(fā)布工作流自動同步永遠不要手動編輯版本號當前版本見 version.json為 1.17.1。描述寫法正誤對比?Use when writing, reviewing, or debugging Terraform/OpenTofu modules, tests, CI, scans, or state ops...?Comprehensive skill for Terraform development covering testing, modules, CI/CD...TDD 鐵律先有失敗測試再改文檔 這是項目最核心的要求CONTRIBUTING.md#L141-L160NO CHANGES WITHOUT TESTING FIRST沒有測試就沒有變更適用于新增內(nèi)容、編輯、重構(gòu)甚至簡單的文檔更新——沒有例外。文檔的 TDD 三階段對應 tests/ 目錄下的三個文件階段做什么記錄位置 RED禁用技能跑 tests/baseline-scenarios.md 中的場景記錄基線行為baseline-results/ GREEN啟用技能跑相同場景驗證行為改善tests/compliance-verification.md REFACTOR封堵新發(fā)現(xiàn)的合理化借口重測直到無懈可擊tests/rationalization-table.md測試時在 PR 描述中必須寫清測了哪些場景、基線行為無變更時代理怎么做、合規(guī)行為有變更后怎么做、以及變更有效的證據(jù)。CI 校驗與 Conventional CommitsPR 標題決定一切 PR 觸發(fā)的 CI 校驗validate.yml會攔截以下問題frontmatter 缺失name/description、name含非法字符、description超 1024 字符PR 標題不合 Conventional Commits 規(guī)范——PR 會被 squash 合并PR 標題就是發(fā)布工作流讀取的提交主題所以標題必須是合法的type: description格式SKILL.md 超過 500 行會告警軟目標 ~300 行POWER.md與 SKILL.md 漂移該文件由 CI 生成禁止手改提交類型直接驅(qū)動版本號類型版本升級用途feat!:/BREAKING CHANGE:Major破壞性變更feat:Minor新功能fix:/docs:/chore:/test:/refactor:Patch修復與雜項合并后發(fā)布全自動完成工作流計算版本號 → 更新 SKILL.md frontmatter 與 CHANGELOG.md → 打 tag 并創(chuàng)建 Release。貢獻者無需管理任何版本號 ?提交 PR 前檢查清單 已識別受影響場景并完成 RED/GREEN 測試決策表在手冊之前無冗余 before/after 對比無 Why this matters 類段落均已轉(zhuǎn)為 ?/?每個小節(jié) 400 tokensSKILL.md 鏈接的錨點保持穩(wěn)定PR 標題為合法 Conventional Commits 格式PR 描述含基線 vs 合規(guī)對比證據(jù)參考文件索引資料路徑貢獻指南本文主要來源CONTRIBUTING.md開發(fā)者規(guī)范與 LLM 消費規(guī)則CLAUDE.md核心技能文件skills/terraform-skill/SKILL.md參考文件目錄8 個專題skills/terraform-skill/references/基線測試場景tests/baseline-scenarios.md合規(guī)驗證tests/compliance-verification.md合理化借口追蹤表tests/rationalization-table.md發(fā)布歷史CHANGELOG.md一句話總結(jié)寫給人看的內(nèi)容要克制寫給 LLM 看的內(nèi)容要精準——遵循決策表先行、Token 預算與 TDD 鐵律你的 terraform-skill 貢獻就能順利通過 CI 與評審 【免費下載鏈接】terraform-skillTerraform OpenTofu Skill for AI Agents - testing, modules, CI/CD, and production patterns項目地址: https://gitcode.com/gh_mirrors/te/terraform-skill創(chuàng)作聲明：本文部分內(nèi)容由AI輔助生成（AIGC），僅供參考 如何給terraform-skill貢獻內(nèi)容：開發(fā)者指南、LLM消費規(guī)則與CI校驗全解析
如何給terraform-skill貢獻內(nèi)容開發(fā)者指南、LLM消費規(guī)則與CI校驗全解析【免費下載鏈接】terraform-skillTerraform OpenTofu Skill for AI Agents - testing, modules, CI/CD, and production patterns項目地址: https://gitcode.com/gh_mirrors/te/terraform-skillterraform-skill 是一個面向 AI 編碼代理的 Terraform / OpenTofu 最佳實踐技能包覆蓋測試框架、模塊開發(fā)、狀態(tài)管理、CI/CD 與安全掃描等生產(chǎn)模式。想給它貢獻內(nèi)容本文基于 CONTRIBUTING.md 與 CLAUDE.md 詳解完整貢獻流程從 Fork 倉庫到 PR 合并重點解析面向 LLM 的消費者規(guī)則、TDD 測試鐵律與 CI 校驗機制幫助你寫出能被順利合并的高質(zhì)量貢獻 5 步快速上手完成你的第一次 terraform-skill 貢獻貢獻流程與常規(guī)開源項目類似但門檻判斷更嚴格Fork 倉庫克隆倉庫到本地git clone https://gitcode.com/gh_mirrors/te/terraform-skill創(chuàng)建功能分支git checkout -b feature/your-topic按規(guī)范修改內(nèi)容下文詳述先測試再提交遵循 TDD 鐵律見下文提交 PR附帶測試證據(jù)??master分支受保護禁止直接推送所有變更必須通過 PR 合入。判斷你的內(nèi)容適不適合貢獻項目明確劃分了好貢獻與不合適的邊界? 歡迎? 不歡迎有社區(qū)共識的 Terraform/OpenTofu 最佳實踐缺乏共識的個人偏好新版本特性的針對性指引Provider 特定的資源細節(jié)應走 Terraform MCP 工具糾正過時或錯誤信息未經(jīng)驗證的變更更好的示例、模式、測試框架改進與 AI 模型已有知識重復的內(nèi)容內(nèi)容落在哪里項目有清晰的分工表詳見 CLAUDE.md#L187-L196決策框架與核心模式進 skills/terraform-skill/SKILL.md約 305 行軟上限目標 ~300 行詳細示例與模板進 skills/terraform-skill/references/ 目錄下的 8 個參考文件。LLM 消費規(guī)則全解析為什么文檔要為機器而寫這是 terraform-skill 貢獻指南中最特別的部分——這份文檔的第一讀者不是人而是檢索事實來回答問題的 LLM。所有對 SKILL.md 和 references/*.md 的修改都必須遵守 CLAUDE.md#L155-L171 中的 6 條強制規(guī)則違者 PR 會被直接拒收 決策表先行手冊在后一個主題有多種可行方案時先給決策表目標 | 選用 | 取舍再寫步驟絕不能把分支藏在正文末尾。砍掉人類腳手架before/after 對比、Why this matters 段落、教學式旁白——如果步驟里已經(jīng)寫了該做什么這類內(nèi)容就是冗余。散文壓縮成 ?/? 規(guī)則凡是以 You should...、Note that...、Keep in mind... 開頭的句子改寫為祈使句 ?/? 條目一條一個事實。每個制品都要掙得自己的 token代碼塊和表格必須包含正文中沒有的新事實只為完整性存在的內(nèi)容一律刪除。錨點穩(wěn)定性SKILL.md 通過#anchor鏈接到參考文件的具體小節(jié)重寫時必須保留頂層### Heading錨點。檢索優(yōu)先排序章節(jié)內(nèi)部按 LLM 需要的順序排列——決策表 → 默認流程 → 備選方案 → ?/? 規(guī)則。Token 預算每個參考小節(jié)目標 400 tokens約 1600 字符超過就拆分或壓縮。技巧包括細節(jié)下沉到 references漸進式披露、表格優(yōu)于散文、跨文件引用而非重復內(nèi)容。Frontmatter 要求SKILL.md 的門面修改 skills/terraform-skill/SKILL.md 時YAML frontmatter 有兩個必填字段CONTRIBUTING.md#L33-L66name技能名僅允許字母、數(shù)字、連字符description≤1024 字符必須以 Use when 開頭寫清楚何時使用觸發(fā)場景與癥狀而不是這個技能做什么metadata.version由發(fā)布工作流自動同步永遠不要手動編輯版本號當前版本見 version.json為 1.17.1。描述寫法正誤對比?Use when writing, reviewing, or debugging Terraform/OpenTofu modules, tests, CI, scans, or state ops...?Comprehensive skill for Terraform development covering testing, modules, CI/CD...TDD 鐵律先有失敗測試再改文檔 這是項目最核心的要求CONTRIBUTING.md#L141-L160NO CHANGES WITHOUT TESTING FIRST沒有測試就沒有變更適用于新增內(nèi)容、編輯、重構(gòu)甚至簡單的文檔更新——沒有例外。文檔的 TDD 三階段對應 tests/ 目錄下的三個文件階段做什么記錄位置 RED禁用技能跑 tests/baseline-scenarios.md 中的場景記錄基線行為baseline-results/ GREEN啟用技能跑相同場景驗證行為改善tests/compliance-verification.md REFACTOR封堵新發(fā)現(xiàn)的合理化借口重測直到無懈可擊tests/rationalization-table.md測試時在 PR 描述中必須寫清測了哪些場景、基線行為無變更時代理怎么做、合規(guī)行為有變更后怎么做、以及變更有效的證據(jù)。CI 校驗與 Conventional CommitsPR 標題決定一切 PR 觸發(fā)的 CI 校驗validate.yml會攔截以下問題frontmatter 缺失name/description、name含非法字符、description超 1024 字符PR 標題不合 Conventional Commits 規(guī)范——PR 會被 squash 合并PR 標題就是發(fā)布工作流讀取的提交主題所以標題必須是合法的type: description格式SKILL.md 超過 500 行會告警軟目標 ~300 行POWER.md與 SKILL.md 漂移該文件由 CI 生成禁止手改提交類型直接驅(qū)動版本號類型版本升級用途feat!:/BREAKING CHANGE:Major破壞性變更feat:Minor新功能fix:/docs:/chore:/test:/refactor:Patch修復與雜項合并后發(fā)布全自動完成工作流計算版本號 → 更新 SKILL.md frontmatter 與 CHANGELOG.md → 打 tag 并創(chuàng)建 Release。貢獻者無需管理任何版本號 ?提交 PR 前檢查清單 已識別受影響場景并完成 RED/GREEN 測試決策表在手冊之前無冗余 before/after 對比無 Why this matters 類段落均已轉(zhuǎn)為 ?/?每個小節(jié) 400 tokensSKILL.md 鏈接的錨點保持穩(wěn)定PR 標題為合法 Conventional Commits 格式PR 描述含基線 vs 合規(guī)對比證據(jù)參考文件索引資料路徑貢獻指南本文主要來源CONTRIBUTING.md開發(fā)者規(guī)范與 LLM 消費規(guī)則CLAUDE.md核心技能文件skills/terraform-skill/SKILL.md參考文件目錄8 個專題skills/terraform-skill/references/基線測試場景tests/baseline-scenarios.md合規(guī)驗證tests/compliance-verification.md合理化借口追蹤表tests/rationalization-table.md發(fā)布歷史CHANGELOG.md一句話總結(jié)寫給人看的內(nèi)容要克制寫給 LLM 看的內(nèi)容要精準——遵循決策表先行、Token 預算與 TDD 鐵律你的 terraform-skill 貢獻就能順利通過 CI 與評審 【免費下載鏈接】terraform-skillTerraform OpenTofu Skill for AI Agents - testing, modules, CI/CD, and production patterns項目地址: https://gitcode.com/gh_mirrors/te/terraform-skill創(chuàng)作聲明：本文部分內(nèi)容由AI輔助生成（AIGC），僅供參考