貢獻開源工具
感謝您有興趣為我們的開源工具集做出貢獻！本文件提供貢獻的指南和說明。
快速入門指南
貢獻類型
1. 工具提交
- 提交符合我們使命的新開源工具
- 工具必須有良好的文件和維護
- 必須在提交範本中包含所有必要資訊
2. 文件改善
- 加強現有工具文件
- 修正錯字或不清楚的說明
- 新增使用範例或教學
3. 錯誤報告
- 回報所列工具的問題
- 提供清楚的重現步驟
- 在相關時包含系統資訊
4. 功能建議
- 為所列工具提出新功能
- 建議改善儲存庫結構
- 推薦新類別或標籤
提交流程
1. 初始提交
- 使用「新工具提交」範本建立新問題
- 對於現有工具，標籤將從「新工具」變更為「編輯工具」
- 提供必要資訊：
- 工具名稱、URL 和類別
- 部署方法和要求
- 目標使用者和使用案例
2. 審查流程
- 問題會自動標示為「新工具」和「需要審查」
- OCF/WPI 團隊會審查提交內容
- 社群成員可以提供回饋
- 工具會根據基本標準進行評估
3. 自動化流程
核准後： - 新增「已核准」標籤並移除「需要審查」 - 自動化的 GitHub Action 工作流程會觸發 - 工具資訊會被處理和驗證 - 文件會自動產生 - 儲存庫會更新為新的工具資訊 - 成功整合後，問題會自動關閉
文件要求
我們儲存庫中的每個工具都必須包含：
1. 總覽
- 工具用途和功能
- 使用案例和優點
- 目標對象
2. 技術細節
- 系統要求
- 依賴項
- 安裝指南
- 設定選項
3. 使用者指南
- 逐步設定
- 基本用法
- 進階功能
- 疑難排解
4. 評估結果
- 效能指標
- 安全性評估
- 可用性發現
- 建議的替代方案
審查流程
1. 初始檢查
- 提供所有必要資訊
- 符合基本品質標準
- 適當的分類
2. 技術審查
- 程式碼品質評估
- 安全性檢查
- 文件審查
3. 社群回饋
- 社群成員可以發表評論
- 改善建議
- 使用案例驗證
4. 最終核准
- OCF/WPI 團隊新增「已核准」標籤
- 自動化整合流程開始
- 變更會提交至儲存庫
樣式指南
文件
- 使用清晰、簡潔的語言
- 在相關時包含程式碼範例
- 遵循 markdown 最佳實務
- 保持格式一致
元資料
- 使用適當的類別和標籤
- 保持描述資訊豐富但簡潔
- 包含所有必要的連結
- 需要時更新時間戳
需要協助？
如果您對貢獻有任何疑問：
1. 檢查現有問題
2. 檢查工作流程執行記錄（如果與自動化相關）
3. 建立一個標示為 question 的新問題
4. 聯絡維護人員
感謝您為讓開源工具對每個人都更容易存取和使用而做出貢獻！