發(fā)布開源項(xiàng)目之前的檢查項(xiàng)

準(zhǔn)備好開源你的項(xiàng)目了嗎？有一份幫助檢查清單。檢查所有內(nèi)容？你準(zhǔn)備開始吧！ 點(diǎn)擊 “publish” 以及拍下自己的后背。

文檔

• [ ] 需要為項(xiàng)目指定一個(gè)開源協(xié)議

• [ ] 項(xiàng)目要有基礎(chǔ)文檔 (README, CONTRIBUTING, CODE_OF_CONDUCT)

• [ ] 易記的項(xiàng)目名，指出項(xiàng)目是做什么的，不能和已存在的項(xiàng)目沖突或者商標(biāo)侵權(quán)

• [ ] 最新的 issue 隊(duì)列，組織和標(biāo)記清除的issues

代碼

• [ ] 項(xiàng)目使用一致的代碼風(fēng)格和明確的功能/方法/可用的名字

• [ ] 注釋清晰的代碼，記錄意圖和邊緣案例

• [ ] 在修改歷史，issues 或者 pull requests 中沒有敏感的信息 (例如 密碼或者其他不能公開的信息)

人

如果你是代表個(gè)人：

• [ ] 你已經(jīng)告訴了你的法律部門，以及/或者理解了你公司（如果你是某一家公司的員工）的開源政策和 IP

如果你有一家公司或者組織：

• [ ] 你已經(jīng)告訴了你的法律部門

• [ ] 你有一個(gè)宣布和促進(jìn)項(xiàng)目的營銷計(jì)劃

• [ ] 一些人被允許管理社區(qū)互動(dòng)（回復(fù) issues，檢查和合并 pull requests）

• [ ] 至少有兩人管理訪問項(xiàng)目