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