Test that SPEC 3.6 lists every confirmable action

未關閉 適合新手
#143 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

維護者通常 1 天內回覆

還沒有人認領這個 Issue。

評估

難度
2/5
預估耗時
1-3 小時
新手友好度
78/100
Issue 類型
功能
描述清晰度
描述清楚
活躍度
活躍
技術堆疊
typescript
領域
testing

研究方向

閱讀 apps/api/src/modules/confirmations/domain/confirmation-token.ts,查看 CONFIRMABLE_ACTIONS 目錄,並檢查 docs/SPEC.md 的 3.6 節。找出現有的單元測試慣例,並新增一個測試,檢查目錄中的每個動作是否都在該節中提及。完成標準是測試現在通過,並且在新增未記錄的虛構動作時失敗。

由索引模型根據 Issue 內容生成。

描述

documentation good first issue priority:P3 track:control-plane

CONFIRMABLE_ACTIONS in apps/api/src/modules/confirmations/domain/confirmation-token.ts is the closed catalog of destructive actions that need a confirmation.

Task

Add a unit test that reads docs/SPEC.md and fails when an action of the catalog is not mentioned in section 3.6, so the documentation cannot fall behind the code.

Acceptance

The test passes today and fails if you add a fake action to the catalog without documenting it.

主要語言
TypeScript
星號
2
分支
1
平均合併
7 小時 17 分鐘
30 天內合併 PR
197

環境準備

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

shipkeepdev/shipkeep 的其他 Issue

查看 shipkeepdev/shipkeep 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。