diff --git "a/\347\254\254\344\270\200\351\203\250\345\210\206\342\200\224\342\200\224\345\210\235\350\257\206\345\274\200\346\272\220/\345\270\270\350\247\201\346\226\207\344\273\266\350\256\244\350\257\206.md" "b/\347\254\254\344\270\200\351\203\250\345\210\206\342\200\224\342\200\224\345\210\235\350\257\206\345\274\200\346\272\220/\345\270\270\350\247\201\346\226\207\344\273\266\350\256\244\350\257\206.md" new file mode 100644 index 0000000000000000000000000000000000000000..d1a2d7142cd0f255dae265372c78f5169952d415 --- /dev/null +++ "b/\347\254\254\344\270\200\351\203\250\345\210\206\342\200\224\342\200\224\345\210\235\350\257\206\345\274\200\346\272\220/\345\270\270\350\247\201\346\226\207\344\273\266\350\256\244\350\257\206.md" @@ -0,0 +1,8 @@ +# 常见文件 +- 一个靠谱的开源项目一般都会有详细的文档, 大部分重要文档都会在项目的顶层目录列出. + + +- LICENSE: 开元项目必须拥有一个**开源协议**, 如果项目源代码开放, 但没有任何的协议许可, 那么就不能称之为开源 +- README: README 是一个介绍性的说明文件, 通常README灰表述项目的用处、发起原因、快速使用等. +- CONTRIBUTING: CONTRIBUTING 文件用来告诉人们如何对项目做出贡献, CONTRIBUTING 中表述了项目需要什么类型的贡献, 社区或者本项目的作业流程, 并非所有的项目都会有这个文件. +- CHANGELOG: CHANGELOG 文件用来记录项目的变更记录, 通常包含**Added**、**Changed**、**Removed**和**Fixed** \ No newline at end of file