Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 2.22 KB

CONTRIBUTING.md

File metadata and controls

40 lines (26 loc) · 2.22 KB
Raw

如何參與貢獻

您好，我是 Pichu ，目前是這個 Repo 的主要負責人。

這個 Repo 的主要目的是提供一個易維護的 pttbbs API 後端，主要範圍在商業邏輯以及 HTTP 等快取的部分。 如果希望找的是如果讀取 BBS 檔案以及資料庫的部分，請見 go-bbs專案。

如果有任何問題您可以透過 g0v Slack 找 pichuchen 或者是Telegram 「Ptt官方app籌備小組」的群組找到我。

Quick Start

開設 ISSUE 以及 Pull Request 的政策

  • 由於希望使用母語開發的因素，因此主要文件以及 ISSUE 等等的會以中文（台灣）的形式發布。
  • 請避免使用 UTF-8 以外的編碼進行交流。
  • 如果使用英文或是其他語言也是OK的，只是可能被回答的時間會晚一點。
  • 開新的 ISSUE 之前請務必確認是否已經有人開過了。
  • Pull Request 發送時請務必註記對應的 ISSUE 編號，原則上不接受沒有 ISSUE 編號的 Pull Request。
  • 由於本專案目標在於使BBS文化得以永續經營下去，會強烈考慮可維護性相關的問題，因此不一定所有個 ISSUE 都會被處理。
  • 可以優先處理有 good first issue / help wanted / bug 標籤的ISSUE。

如何參與交流

給參加者

  • 交流時請先確認 g0v 的 CoC
  • 如果有自己可以做而且沒有被指派的 ISSUE 的話，請在 ISSUE 下方回應「交給我」後再開始開發。
  • 關於 good first issue 是推薦給新手的
  • 如果您可能要離開作業半天以上的話，請確保其他人可以接續您的工作。（如果長時間佔住 Issue，那麼這個 Issue 會被卡住。）
  • 對於一天以上沒有更新的 ISSUE，我們可能會解除指派，在工作中善用 Draft Pull Request 的話可以讓大家更輕易地瞭解您目前的進度。
  • ISSUE 相關的問題請在 ISSUE 內回應欄討論（而不是 Slack）。
  • 我們也接受建議！請積極的開新的 Issue 吧。

開發相關的資訊