From c19fa5565df54cfb0b712027c7aca4cea936f196 Mon Sep 17 00:00:00 2001 From: taotieren Date: Thu, 17 Dec 2020 14:16:08 +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/=E6=9C=89=E4=BA=86=E5=BC=80?= =?UTF-8?q?=E6=BA=90=E7=9A=84=E6=83=B3=E6=B3=95=E5=90=8E=E4=BB=8E=E4=BD=95?= =?UTF-8?q?=E5=BC=80=E5=A7=8B.md.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ...16\344\275\225\345\274\200\345\247\213.md" | 24 +++++++++---------- 1 file changed, 12 insertions(+), 12 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/\346\234\211\344\272\206\345\274\200\346\272\220\347\232\204\346\203\263\346\263\225\345\220\216\344\273\216\344\275\225\345\274\200\345\247\213.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/\346\234\211\344\272\206\345\274\200\346\272\220\347\232\204\346\203\263\346\263\225\345\220\216\344\273\216\344\275\225\345\274\200\345\247\213.md" index a350465..34096cb 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/\346\234\211\344\272\206\345\274\200\346\272\220\347\232\204\346\203\263\346\263\225\345\220\216\344\273\216\344\275\225\345\274\200\345\247\213.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/\346\234\211\344\272\206\345\274\200\346\272\220\347\232\204\346\203\263\346\263\225\345\220\216\344\273\216\344\275\225\345\274\200\345\247\213.md" @@ -24,7 +24,7 @@ 然后再去找一下这个赛道里其他的项目，挑一些 Star 数相对比较高的项目看看。再和最活跃的那个项目，进行一个横向对比。思考下为什么这个赛道里排名最高的那个项目会得到使用者的青睐。这样总结一番，你会对在这个赛道里如何脱颖而出有一个大致的判断。这会对你的项目要做成什么样有很大的帮助。 -同时也建议去看看赛道里高 Star 项目的 Issue，Issue 基本能反映出一个项目历史的迭代过程和目前的进展，这当中有用户提出的改进，有作者自己加的一些特性。每个 Issue 有一个标签，能反映出这个 Issue 是 bug 还是增强，还是新特性。建议你只过滤出增强和新特性。这基本上就是一个项目迭代的历史过程了。如果一个项目都没有 Issue，只能说明迭代度比较差，或者受到的关注度使用度比较少。这种项目也基本没有看的必要。 +同时也建议去看看赛道里高 Star 项目的 Issue，Issue 基本能反映出一个项目历史的迭代过程和目前的进展，这当中有用户提出的改进，有作者自己加的一些特性。每个 Issue 有一个标签，能反映出这个 Issue 是 Bug 还是增强，还是新特性。建议你只过滤出增强和新特性。这基本上就是一个项目迭代的历史过程了。如果一个项目都没有 Issue，只能说明迭代度比较差，或者受到的关注度使用度比较少。这种项目也基本没有看的必要。 如果你发现在这个赛道里有一大批活跃高 Star 的项目，他们也各有特点。基本上可以解决所有的这个领域的痛点。那么还是建议你换一个赛道。你的项目一定要有自己的特点，如果你的项目的特性，使用方式都和其他项目差不多或者还不如其他项目，那为什么指望用户用你的项目呢。 @@ -63,11 +63,11 @@ 项目名是项目的门面，就像一个人的名字。在定名字的时候，也不要过于花哨，以贴切简洁为主。 -## 为你的项目写一个 Readme 文件 +## 为你的项目写一个 README 文件 -基于 Git 规范的代码托管平台，一般 Readme 都能直接展示在你的项目首页，可以起一个快速介绍，快速上手的作用。 +基于 Git 规范的代码托管平台，一般 README 都能直接展示在你的项目首页，可以起一个快速介绍，快速上手的作用。 -一个好的 Readme 应该包含以下几点： +一个好的 README 应该包含以下几点： 1）项目的名称和简介，基本上简短概括为主，说明你的项目主要用在哪些领域，能解决哪些问题。 @@ -75,7 +75,7 @@ 3）简单的快速开始用例，这部分旨在用最快的方式让别人通过用例了解你的项目。你项目中细节的说明和配置不应该放到这里。否则就会显得太冗长了。 -4）个人不太建议把项目的文档写在 readme 中，因为文档本身是项目使用的详细说明，会涵盖各个方面，放到 readme 里面不太妥当，如果你有自己的文档页面，应当在 readme 里面放一个超链进行跳转。当然如果你的项目非常的小，基本上一页纸就能说完的事情，放到 readme 中也是可以的。 +4）个人不太建议把项目的文档写在 README 中，因为文档本身是项目使用的详细说明，会涵盖各个方面，放到 README 里面不太妥当，如果你有自己的文档页面，应当在 README 里面放一个超链进行跳转。当然如果你的项目非常的小，基本上一页纸就能说完的事情，放到 README 中也是可以的。 5）作者的介绍和联系方式（或者提供提 Issue 或者 Pull Requests 的方式等）。让别人碰到问题时能快速联系到你。 @@ -83,18 +83,18 @@ 如果你想做成一个成熟规范的开源项目，那么版本号应当遵从开源项目的规范，对你的迭代也有帮助。 -版本号建议为 3 位数字，比如 `1.1.0`，`1.5.1` 这样，但是我们经常看到在版本号后面还有一些修饰词，比如 `beta`、`release` 等等，对于这部分的规范如下： +版本号建议为 3 位数字，比如 `1.1.0`，`1.5.1` 这样，但是我们经常看到在版本号后面还有一些修饰词，比如`Alpha`、`Beta`、`Release` 等等，对于这部分的规范如下： -- `alpha`（如`1.1.0-alpha`）：内部测试版本，BUG可能比较多，一般用于开发人员内部使用 -- `beta`（如`1.1.0-beta`）：测试版，BUG 相比 alpha 少一点，但同样不建议用于生产环境，一般用于面向急于使用新功能的群众进行公测，并向开发人员进行反馈 -- `rc`（如`1.1.0-rc`）：release candidate，即将作为正式版发布，BUG 较少，正式版之前的最后一个测试版 -- `ga`（如`1.1.0-ga`）：general availability，首次发行的稳定版，比较稳定，可以用于生产 -- `release`或者留空（如`1.1.0-release`、`1.1.0`）：最终发布版，可以面向广大的一般用户 +- `Alpha`（如 `1.1.0-alpha`）：内部测试版本，Bug 可能比较多，一般用于开发人员内部使用 +- `Beta`（如 `1.1.0-beta`）：用户测试版，Bug 相比 Alpha 少一点，但同样不建议用于生产环境，一般用于面向急于使用新功能的群众进行公测，并向开发人员进行反馈 +- `RC`（如 `1.1.0-rc`）：Release Candidate，即将作为正式版发布，Bug 较少，正式版之前的最后一个测试版 +- `GA`（如 `1.1.0-ga`）：General Availability，首次发行的稳定版，比较稳定，可以用于生产 +- `Release` 或者留空（如 `1.1.0-release`、`1.1.0`）：最终发布版，可以面向广大的一般用户 那对于 3 位数的版本号的管理策略如下： - 项目初始版本可以是 `1.0.0` -- 项目进行 BUG 修正时，最后一位加 1，比如 `1.0.1` +- 项目进行 Bug 修正时，最后一位加 1，比如 `1.0.1` - 项目有新特性发布时，中间一位数加 1，同时最后一位复位为 0，比如 `1.1.0` - 项目有重大特性发布，同时结构可能不向下兼容时，第一位数字加 1，其他位数复位为 0，比如 `2.0.0` -- Gitee