Skip to content

Latest commit

 

History

History
53 lines (37 loc) · 2.3 KB

CONTRIBUTING.md

File metadata and controls

53 lines (37 loc) · 2.3 KB

如何貢獻

我們歡迎各種類型的貢獻,包括但不限於:

  • 程式碼修正
  • 文件更新
  • 新功能

貢獻指南

  • 再提交貢獻前,請先閱讀這份指南。
  • 請將您的貢獻集中在單一議題上。
  • 確保您的程式碼符合我們的風格指引。
  • 若您為開發者可參考開發的相關資訊

貢獻流程

  1. 請以 release 分支作為基礎進行開發,將您想要貢獻的東西增加上去
  2. 開啟 pull request 時請設定以分支 release 為併入的目標
  3. 想確認 pull request 的貢獻是否符合我們的風格與品質可執行下列指令或經由團隊成員評論觸發 CI 執行
  • 建置前
    • pnpm fmt.check
  • 建置後
    • pnpm a11y.check
    • lhci autorun
  1. 團隊審核後完成即併入 release 並建置預覽版網站
  2. 再由團隊確認分支 release 是否合併回分支 main 並正式上線

您找到了一個程式錯誤(Bug)嗎?

  • 如果您找到了一個資訊安全漏洞,請不要建立一個 issue, 而是先查閱我們的安全性政策
  • 您可以藉由搜索關鍵字來查詢,確定現有 issue 中是否有已經回報的內容。
  • 如果找不到相關的 issue,請開啟新的 issue。請務必包含標題、清晰的描述、盡可能的相關資訊,以及程式反範例或可以執行的測試方法,用來示範預期的行爲。
  • 如果可以請使用Issue 範本來建立並將相關的內容填寫上去。

您修復了一個程式錯誤(Bug)嗎?

  • 建立一個 pull request 並附上已修復程式碼。
  • 確認PR清楚描述了問題和解決方案,如果可以也一起附上相關的 Issue 編號。
  • 如果可以請使用pull request範本來建立並將相關的內容填寫上去

您打算新增新功能或更改現有功能嗎? 您想要協助更新文件嗎?

  • 您可以藉由搜索關鍵字來查詢,現有的 issue 與 pull request 是否已經有已經存在的內容。
  • 如果找不到相關的 issue 或 pull request,請建立一個新的 pull request 並附上相關內容
  • 如果是新增功能或更改現有功能,請描述理由及做法。
  • 如果是更新文件,請說明修改的想法。

謝謝您的貢獻!

若還有其他問題的話也歡迎與我們聯繫!