diff --git "a/\347\254\254\345\233\233\351\203\250\345\210\206\357\274\232\345\220\257\345\212\250\350\207\252\345\267\261\347\232\204\345\274\200\346\272\220\351\241\271\347\233\256/\347\254\254 2 \345\260\217\350\212\202\357\274\232\344\270\272\345\274\200\346\272\220\351\241\271\347\233\256\345\273\272\347\253\213\350\211\257\345\245\275\347\232\204\345\237\272\347\241\200.md" "b/\347\254\254\345\233\233\351\203\250\345\210\206\357\274\232\345\220\257\345\212\250\350\207\252\345\267\261\347\232\204\345\274\200\346\272\220\351\241\271\347\233\256/\347\254\254 2 \345\260\217\350\212\202\357\274\232\344\270\272\345\274\200\346\272\220\351\241\271\347\233\256\345\273\272\347\253\213\350\211\257\345\245\275\347\232\204\345\237\272\347\241\200.md" index 41a9bd06508599b6ac58d5bdf5639a27390f7acc..58a4263748a0a9d48140303c400586b3f32131eb 100644 --- "a/\347\254\254\345\233\233\351\203\250\345\210\206\357\274\232\345\220\257\345\212\250\350\207\252\345\267\261\347\232\204\345\274\200\346\272\220\351\241\271\347\233\256/\347\254\254 2 \345\260\217\350\212\202\357\274\232\344\270\272\345\274\200\346\272\220\351\241\271\347\233\256\345\273\272\347\253\213\350\211\257\345\245\275\347\232\204\345\237\272\347\241\200.md" +++ "b/\347\254\254\345\233\233\351\203\250\345\210\206\357\274\232\345\220\257\345\212\250\350\207\252\345\267\261\347\232\204\345\274\200\346\272\220\351\241\271\347\233\256/\347\254\254 2 \345\260\217\350\212\202\357\274\232\344\270\272\345\274\200\346\272\220\351\241\271\347\233\256\345\273\272\347\253\213\350\211\257\345\245\275\347\232\204\345\237\272\347\241\200.md" @@ -1,5 +1,6 @@ # 第 2 小节：为开源项目建立良好的基础 -### 项目命名的学问 + +## 项目命名的学问 命名对于程序员来说，简直就是编程路上的绊脚石。几乎每一行代码，都深受着类名、变量名、方法名、参数名的折磨。当然，也不是全都无迹可寻。代码中的命名通常可以通过它在上下文中的作用、角色来命名，也可以参考各种设计模式中的习惯命名。 @@ -26,7 +27,7 @@ 相比还有很多优秀的项目，都有这种让人过目不忘的名称，欢迎继续补充。 -### 如何打造一个优秀的 README +## 如何打造一个优秀的 README README 应该包含哪些内容： @@ -46,7 +47,7 @@ README 应该包含哪些内容： 也可以参考成熟的开源项目以及同类型开源项目中的 README 的内容。 -### 为项目撰写文档 +## 为项目撰写文档 项目文档是开源项目非常重要的一个部分，很多开发者会根据项目文档来决定是否使用或学习该项目，并且非常关注项目文档的入门部分。 @@ -72,7 +73,7 @@ README 应该包含哪些内容： - [Docusaurus](https://docusaurus.io) - [Daux.io](http://daux.io) -### 开源项目的代码质量要求 +## 开源项目的代码质量要求 一个认真打造的开源项目，肯定是希望有其他用户来使用，更希望有更多外部贡献者能参与进来的。那么评价一个开源项目好不好，代码的质量就是非常重要的衡量指标了。 @@ -98,7 +99,7 @@ README 应该包含哪些内容： 第六点，代码的注释。开源项目有一个很大的特点就是任何人都可以自愿为其在符合开源协议的情况下进行二次开发或者为其贡献出自己的代码，因此您所写出的应有较高的可读性以避免在他人想要进行贡献时因为代码的阅读产生障碍。所以一个好的开源项目应具有完善的代码注释，这也同样是一个良好的开发习惯，我们也有应理由相信我们能够做在这方面的更好！ -### 本部分内容贡献者 +## 本部分内容贡献者 [JamesYeung](https://gitee.com/JamesYeung)、[雪山凌狐](https://gitee.com/xueshanlinghu)、[ORH](https://gitee.com/orh)、[louislivi](https://gitee.com/louislivi)、[itas109](https://gitee.com/itas109)、[taotieren](https://gitee.com/taotieren)、[沈唁](https://gitee.com/sy-records)、[晓空](https://gitee.com/rcraft)