Skip to content

Latest commit

 

History

History
73 lines (50 loc) · 1.7 KB

File metadata and controls

73 lines (50 loc) · 1.7 KB

貢獻指南

感謝您考慮為 EisonAI 做出貢獻!

如何貢獻

  1. Fork 本倉庫
  2. 創建您的特性分支 (git checkout -b feature/AmazingFeature)
  3. 提交您的修改 (git commit -m 'Add some AmazingFeature')
  4. 推送到分支 (git push origin feature/AmazingFeature)
  5. 開啟一個 Pull Request

開發流程

  1. 確保您的開發環境符合系統要求
  2. 在進行任何更改之前,請先同步您的 fork 與上游倉庫
  3. 創建一個新的分支進行開發
  4. 編寫代碼時請遵循現有的代碼風格
  5. 確保所有測試都能通過
  6. 更新文檔(如有必要)

提交說明規範

我們使用約定式提交規範。每個提交消息都應該包含以下結構:

<類型>[可選範圍]: <描述>

[可選正文]

[可選頁腳]

類型必須是以下之一:

  • feat: 新功能
  • fix: 錯誤修復
  • docs: 文檔更改
  • style: 代碼格式修改
  • refactor: 代碼重構
  • perf: 性能優化
  • test: 測試相關
  • chore: 構建過程或輔助工具的變動

代碼審查

  • 所有的代碼更改都需要經過審查
  • 審查者可能會要求進行更改
  • 代碼必須符合項目的代碼規範
  • 所有測試都必須通過

報告問題

如果您發現了問題,請使用 issue 模板提交問題報告,並包含:

  • 問題的清晰描述
  • 復現步驟
  • 預期行為
  • 實際行為
  • 系統環境信息
  • 相關的日誌輸出

安全問題

如果您發現了安全漏洞,請不要公開報告。相反,請發送電子郵件至 security@example.com

行為準則

請遵循我們的 行為準則

許可證

通過貢獻您的代碼,您同意您的貢獻將根據項目的 MIT 許可證進行授權。