From 579bafe2642c88a5cc084740a182901379227280 Mon Sep 17 00:00:00 2001 From: taotieren Date: Thu, 17 Dec 2020 11:09:59 +0800 Subject: [PATCH] =?UTF-8?q?update=20=E7=AC=AC4=E9=83=A8=E5=88=86=E2=80=94?= =?UTF-8?q?=E2=80=94=E5=90=AF=E5=8A=A8=E8=87=AA=E5=B7=B1=E7=9A=84=E5=BC=80?= =?UTF-8?q?=E6=BA=90=E9=A1=B9=E7=9B=AE/=E4=B8=BA=E5=BC=80=E6=BA=90?= =?UTF-8?q?=E9=A1=B9=E7=9B=AE=E5=BB=BA=E7=AB=8B=E8=89=AF=E5=A5=BD=E7=9A=84?= =?UTF-8?q?=E5=9F=BA=E7=A1=80.md.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ...75\347\232\204\345\237\272\347\241\200.md" | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git "a/\347\254\2544\351\203\250\345\210\206\342\200\224\342\200\224\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/\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\2544\351\203\250\345\210\206\342\200\224\342\200\224\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/\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 1ddfb0a..36bc787 100644 --- "a/\347\254\2544\351\203\250\345\210\206\342\200\224\342\200\224\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/\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\2544\351\203\250\345\210\206\342\200\224\342\200\224\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/\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" @@ -32,21 +32,21 @@ README 应该包含哪些内容： - 项目名称 -- 项目LOGO：可以设计一张中意的图片，也可以通过[Patorjk](http://patorjk.com/software/taag)生成你想要的字符画。 -- 多语言切换：推荐中英切换链接展现，在项目根目录建立`README.md`以及`README-ZH.md`，若以中文为主则为`README-EN.md`文件。 -- 项目勋章（Badge）：这是一个很好玩的东西并且可以增加项目趣味性，可以通过[Shields](http://img.shields.io)进行生成你想要的 Badge 进行展现。 +- 项目 LOGO：可以设计一张中意的图片，也可以通过 [Patorjk](http://patorjk.com/software/taag) 生成你想要的字符画。 +- 多语言切换：推荐中英切换链接展现，在项目根目录建立 `README.md` 以及 `README-ZH.md`，若以中文为主则为 `README-EN.md` 文件。 +- 项目勋章（Badge）：这是一个很好玩的东西并且可以增加项目趣味性，可以通过 [Shields](http://img.shields.io) 进行生成你想要的 Badge 进行展现。 - 项目背景：项目背景很简单，就是你为什么做这个项目，动机和背景是什么。 - 项目特点：项目的核心价值，对比同类型项目的优势以及项目自身的特点是什么。 - 安装：如何进行项目的安装。 -- 使用：如何使用该项目，这里如果使用方式简单可以直接写进README中如果较为复杂则引入文档链接地址进行指引。 -- 项目参与者：该项目的参与人展现，可以借助[OpenCollective](https://opencollective.com)进行贡献者信息展示。 -- 讨论与反馈：文档以及项目官网指引，项目沟通渠道如QQ群，公众号，项目社区等地址。 -- 项目打赏方式：国内微信，支付宝，还可以使用 Gitee 一键接入打赏，国外常用的有 PayPal,OpenCollective。 +- 使用：如何使用该项目，这里如果使用方式简单可以直接写进 README 中如果较为复杂则引入文档链接地址进行指引。 +- 项目参与者：该项目的参与人展现，可以借助 [OpenCollective](https://opencollective.com) 进行贡献者信息展示。 +- 讨论与反馈：文档以及项目官网指引，项目沟通渠道如 QQ 群，公众号，TG 群/频道，项目社区等地址。 +- 项目打赏方式：国内微信，支付宝，还可以使用 Gitee 一键接入打赏，国外常用的有 PayPal, OpenCollective。 - 参与贡献方式：指引开发者们如何参与到项目中协同完善整个开源项目。 - 开源协议：开源协议类型指引。 -参考成熟的开源项目的README中的内容以及同类型开源项目中的README。 +参考成熟的开源项目的 README 中的内容以及同类型开源项目中的README。 ### 为项目撰写文档 @@ -59,7 +59,7 @@ README 应该包含哪些内容： - 基础指南：各模块使用说明、旧版本迁移指南等。 - 进阶指南：架构设计说明、高级用法等。 - 技术博客：知识普及、使用技巧、性能对比、应用案例等。 -- 技术支持：线上社区（如微信群、QQ群、钉钉群、微博、公众号等）、线下交流会、培训、视频、推荐书籍及博客等。 +- 技术支持：线上社区（如微信群、QQ 群、钉钉群、微博、公众号、TG 群/频道(可配置 bot 持续跟进项目进度)等）、线下交流会、培训、视频、推荐书籍及博客等。 - 版本发布计划：制定版本发布时间表，规划项目的未来发展方向等。 - 国际化：面向全球开发者的项目需要支持多国语言的项目文档。 @@ -74,11 +74,11 @@ README 应该包含哪些内容： 代码规范一般都可以参考每个语言的官方规范，并借助静态检查、代码编辑器插件、lints 等工具，如常见的 EditorConfig、StyleCop、tslint、style lint 等等，在每个 Pull Request 时都先进行编码风格检查。 -说到规范，还有就是进行 Git 分布式协作时的规范，如分支命名规范、commit message 规范、issue 模板、pull request 模板等等。把这些都拟定起来后，这个项目看起来就很正规、很美观。 +说到规范，还有就是进行 Git 分布式协作时的规范，如分支命名规范、Commit Message 规范、Issue 模板、Pull Request 模板等等。把这些都拟定起来后，这个项目看起来就很正规、很美观。 而一个开源项目的质量，除了代码本身以外，更重要的是整个项目的状态。 -第一点，这个项目必须编译通过。我们可以通过 CI（Continuous integration 持续集成）来把每次合并后的代码编译一遍，把编译状态通过 Badge 来展示，常见 CI 工具有Travis CI 和 Jenkins。 +第一点，这个项目必须编译通过。我们可以通过 CI（Continuous Integration 持续集成）来把每次合并后的代码编译一遍，把编译状态通过 Badge 来展示，常见 CI 工具有 Travis CI 和 Jenkins。 第二点，就是运行状况。是否能正常运行也是最基本的检查点了，有条件的话最好是通过 CI/CD 来把 Demo 站点运行起来。有一个可让用户即时尝试的 Demo，对开源项目的成功是非常有帮助的。 -- Gitee