EpoCanvas 貢獻與官方文件編輯規範
COMMUNITY-009 共同維護 正體中文基線
本頁說明如何協助修正 EpoCanvas 的公開政策、工程規範與專案說明。官方文件代表專案或社群的共同規則,不等同於任何一位作者的個人文章。
[!IMPORTANT] 你可以提出修訂建議,但「提交建議」不等於「規則已生效」。只有經過內容審閱、必要的程式碼或測試核對,並正式合併至專案的版本,才可以被引用為官方說明。
1. 哪些內容可以貢獻
目前可提出貢獻的內容包括:
docs/community/:社群公約、評論、隱私、帳號、安全、授權與申訴等公開政策;docs/standards/:指標、內容撰寫、版本、文件生命週期與系統邊界等工程規範;docs/roadmap.md與docs/operations/:專案狀態、發布流程與事件處理說明;- 程式碼、測試、設定或資料結構的可重現問題;
- 普通文章中的錯字、來源補充、技術勘誤與讀者體驗回饋。
普通文章位於 src/content/posts/,其觀點與敘事不會自動成為社群政策。若一篇文章提出了規則建議,仍須轉入相應的官方文件並完成審閱,才會成為可引用的專案契約。
2. 提出問題與修訂的方法
你可以透過專案的程式碼提交、Issue/變更請求或 contact@epocanvas.com 提出建議。提交時請盡量包含:
- 可定位的頁面、檔案、章節或 API 路由;
- 目前文字與實際行為的差異,包含可重現的步驟或最小案例;
- 你建議採用的文字、規則或驗收方式;
- 可能受影響的讀者、資料、權限、第三方服務與相容性;
- 若是勘誤,說明來源、測試結果或其他可核對證據。
請不要在公開 Issue、評論或變更請求中貼上密碼、API 金鑰、會話令牌、完整個人資料、支付資料或尚未遮蔽的漏洞利用細節。安全問題請改依安全問題通報規範私下提交。
3. 官方文件的編輯要求
官方文件至少應符合以下要求:
- 明確標示適用範圍、更新日期與必要的版本資訊;
- 區分
SOURCE-VERIFIED、TEST-VERIFIED、LIVE-VERIFIED、KNOWN-GAP與PROPOSED,不把規劃寫成現況; - 涉及 API、權限、個人資料、支付或第三方服務時,附上對應的程式碼、設定、測試或失敗邊界;
- 使用正體中文作為目前官方政策與工程規範的編輯基線,並保留專有名詞、程式碼與路由的準確拼法;
- 讓標題層級、表格、連結、程式碼區塊與圖片替代文字可以被鍵盤與輔助技術理解;
- 不以徽章、截圖、單次請求成功或歷史提交推導出未被服務端驗證的權限與承諾。
目前不要求同一批變更同步翻譯所有語言版本。語言版本的適用順序與狀態,請參考翻譯與多語言維護政策。
4. 審閱與正式生效
一般錯字、連結或格式修正可以由維護者進行輕量審閱。若變更涉及下列任一項,應在合併前完成相稱的工程核對:
- 評論、帳號、會話、Reaction 或管理權限;
- 個人資料、公開欄位、保留期限或刪除流程;
- 支付、退款、通知或第三方服務的責任邊界;
- 資料庫 migration、API 請求/回應、路由或建置流程;
- 社群公約、處置、檢舉或申訴的實質改變。
審閱結果應說明變更範圍、驗證命令或證據等級。文件變更應以可追溯的 Git Commit 保存;若同時修改程式碼,應讓文件、測試與實際行為在同一個發布範圍內可以互相對照。
5. 署名、授權與撤回
提出建議不會自動轉移你的著作權。提交到專案的補丁、文件文字與程式碼,須符合內容授權與版權說明及相關第三方授權。若你引用他人內容,請保留來源、授權與必要的修改說明。
若你後來發現貢獻包含錯誤、敏感資料或權利問題,請盡快聯絡維護者並提供可定位資訊。站方可以先暫停公開、修訂或移除有問題的部分;已經進入建置產物、備份、通知或審計紀錄的副本,不一定能立即全部撤回。
6. 爭議與規範衝突
若普通文章、介面文案、程式碼註解與官方政策互相矛盾,應先依社群政策總覽及相應政策頁處理,再向維護者報告差異。若官方政策與服務端實作不一致,文件應標記已知差異,並以當下服務端驗證結果作為實際權限依據,直到修訂完成。
最後更新:2026-10-20。




