文檔是開源項目的重要組成部分。結構清晰、內容詳細且準確、易於理解，這樣的文檔可以讓用户更容易理解並上手使用開源項目，在使用的過程中，大部分問題也可以通過閲讀理解文檔來解決。在開源數據庫的世界裏，一份完整、準確的文檔不僅是技術的指南針，更是社區成長的基石。
作為一款基於 PostgreSQL 的開源數據庫，IvorySQL 一直致力於提供更優質的用户體驗。然而，隨着功能的不斷迭代和任務的增多，IvorySQL 文檔還有待進一步完善。為了讓文檔更全面、更易用，同時激發社區活力，我們決定將文檔更新任務開放給整個社區，並通過豐厚的獎勵激勵大家參與！
IvorySQL 文檔共建計劃第一期現已正式開啓！這一期活動為期 3 個月，重點聚焦新增文檔內容。我們誠摯邀請您加入，一起優化文檔結構、補充缺失目錄，並通過實際貢獻贏得獎勵。未來，我們還將不定期開展後續期活動，讓共建成為 IvorySQL 社區的常態。
活動時間
- 活動開始時間：2025 年 9 月 23 日
- 活動結束時間：2025 年 12 月 23 日
活動任務
- 撰寫新文檔（包括中英文兩版），提交 PR
- 對現有文檔結構提出建議，如需要新增哪些文檔，文檔目錄調整等等（issue）
- 對現有文檔可進行驗證和檢查，如有錯誤可提交修改建議（issue）或直接修改（PR）
活動參與方式
- 方式一：提 PR 完成任務列表中的任務 （推薦）
- 在活動任務列表中，選擇感興趣的任務並點開該任務。
- 在任務的 issue 或者 pull request (PR) 上，通過在 comment 中添加 /assign 命令認領任務。
- 提交 PR 解決任務，在 PR 描述中提供 PR 相關的 issue 鏈接，在 PR comment 中通過添加 /label ivorysql-docs-build 命令標識 PR，並處理 PR 收到的評審建議。
- 方式二：提 issue 指出文檔問題，包含但不限於文檔目錄結構以及文檔內容的準確性、完整性、清晰性等問題。
- 方式三：提 PR 解決任何文檔問題。
- 方式四：為活動任務列表中的 issue 提供有價值的評論。
我們優化後的文檔結構如下（未更新到官網文檔）：https://www.kdocs.cn/l/cg7tqtbtTXYB
注：此活動相關的 PR，請提交到master分支下。
活動獎勵
凡是參與了本次活動，提交的意見被採納，提交的 PR 被合併，即視為做出了貢獻，即可獲得 IvorySQL 貢獻者證書。
此外還有好禮相送。
參與獎：凡是提交 issue，對文檔結構或文檔內容提出任何建議並最終被採納的，可獲得參與獎——IvorySQL 社區周邊禮包：IvorySQL T 恤、IvorySQL 帆布袋、IvorySQL 冰箱貼、IvorySQL 眼罩等。
另外，按照最終積分，設置以下獎勵：
- 一等獎，獎品：beats 頭戴式藍牙耳機
- 二等獎，獎品：定製機械鍵盤
- 三等獎，獎品：3C 認證充電寶+一拖三數據線
另外，所有參與者還可獲得書籍一本：
積分規則如下：
| 貢獻方式 | 積分 | 備註 |
|---|---|---|
| 領取任務 | 1 | 每領取一個任務，獲得 1 分 |
| 提交任務 PR | 5 | 每提交一個任務 PR，獲得 5 分 |
| 任務 PR 被合併 | 10 | 每一個任務 PR 被合併，獲得 10 分 |
| 提交 issue | 2 | 每提交一個 issue，獲得 2 分 |
| issue 被採納 | 4 | 每一個 issue 被採納，獲得 4 分 |
注：以上僅針對於本次活動中説明的對應方式，以上 PR 和 issue 提交都應在文檔倉庫下。
FAQ
- 參與本活動需要什麼條件？
需要有 GitHub 賬號，在提交 PR 前閲讀 IvorySQL 貢獻流程指南，並簽署貢獻者許可協議（CLA）。為了大家更流暢的撰寫文檔，請閲讀文檔語法參考。
- IvorySQL 項目的 GitHub 倉庫和文檔倉庫地址是什麼？
- IvorySQL：https://github.com/IvorySQL/IvorySQL
- IvorySQL 文檔：https://github.com/IvorySQL/ivorysql_docs
- 提交的 issue 和 PR 一定會被採納嗎？
貢獻者提交 issue 後，我們會進行審核，如符合需求，會被採納。
貢獻者提交 PR 後，同樣會進行審核，並反饋修改建議，因此一個新的文檔可能會進行多次修改，直到符合合併條件。
- 參與活動期間，有問題如何獲得幫助？
您可以加入本次活動的專屬交流微信羣，在羣內進行交流。
進羣方式：添加微信小助理 IvorySQL_official，備註參加文檔活動第一期。或直接掃描下方二維碼進羣。
