
build/ 構(gòu)建腳本
dist/ 編譯出來的發(fā)布版
docs/ 文檔
examples/ 示例文件(如果你寫的是庫的話)
src/ 源碼
test/ 測(cè)試腳本
.babelrc Babel 交叉編譯的配置
.eslintrc ESLint 測(cè)試配置
**LICENSE **授權(quán)協(xié)議
**README.md **自述文件,里面至少得寫:
項(xiàng)目的特色
各種 Badge 比如 CI 的
下載安裝
示例運(yùn)行/使用
怎么編譯(尤其 C/C++,要把編譯器、要裝什么工具、依賴庫全部寫清楚。要帶版本號(hào)!)
怎么參與
circle.yml Circle CI 持續(xù)集成配置文件(當(dāng)然你可能用別的 CI,名字會(huì)變。比如我那個(gè) otfcc 使用了兩個(gè) CI:Travis 和 Appveyor,就寫了兩個(gè)配置)
bower.json Bower 包管理器配置文件
package.json npm 包管理器配置文件
作者:Belleve鏈接:https://www.zhihu.com/question/48019650/answer/109951418來源:知乎著作權(quán)歸作者所有。商業(yè)轉(zhuǎn)載請(qǐng)聯(lián)系作者獲得授權(quán),非商業(yè)轉(zhuǎn)載請(qǐng)注明出處。
1.有文檔說明2.有開源協(xié)議著名并遵守其要求3.寫好每次commit的說明注釋4.有人看著issue和pr,別完全不鳥5.代碼格式、命名什么的遵循一定規(guī)范6.對(duì)于在線項(xiàng)目盡可能提供點(diǎn)兒例子7.有穩(wěn)定版本請(qǐng)?zhí)峁﹔elease