如何在Github上创建一个有逼格的开源项目 · Issue #25 · zhongl／zhongl.github.com · GitHub...

男娘i 2023-09-24 08:58 42阅读 0赞

首先, 我要感谢 Github 让开源变得如此简单, 简单到只需要有勇气就行.

门槛虽然降低了, 只可惜大多数程序猿并没有足够(Hua)严(Xin)肃(Si)对待, 使得开源的项目就好像只是公开的学习笔记, 无人问津, 完全丧失应有的意义.

本文稍许入门的聊聊, 如何让你的项目严(Bi)肃(Ge)起来, 搞不好有人会来 Star, Fork, 甚至 Pull Request 呢!

项目名字当然是第一重要的, 不过一个好名字着实不好想. 因此, 项目描述(Description)是不能轻视的, 简单一句话介绍好你的项目是什么, 往往决定别人是否会继续看你的 README.

![Github Description][]

Description 最好用英文, Github 是一个全球性的码农社交网站, 你的项目不要排斥歪果仁嘛! 当然, 这不是重点, 重点是 Description 和 Name 一样是搜索关键字的索引来源, 对搜索引擎友好, 它就会让你的项目排名靠前, 这个好处你肯定是懂的.

什么, 英文不好? 四六级没过, 翻译软件总会用吧?

Topic (上图底部那一行) 相当于项目的关键字, 同样地有益于搜索引擎提升关联权重.

项目可以没有 Description 和 Topic, 但一定不能没有 README. 既然都开源了, 若有人无论是以何种方式看到了你的项目, 然后他却不知道如何开始, 一切前功尽弃.

README 正如其名, 是希望看到项目的人第一个了解的就是这个文件里的内容, 以此引导他快速且恰当地用起来, 从而理解这个项目对他的价值.

内容怎么写? 你可以参考对你价值最大的开源项目, 参考它们是如何写, 一定错不了.

嗯, 你可能心里犯嘀咕, 那个太专业了, 内容太详事, 写不来(其实是懒).

这里捎带些私货为例, 介绍常见的两种项目类型的 README 至少要写些什么:

交代库是用来解决什么问题,

示范库基本(常用)的用法,

介绍使用时依赖(或安装)的方法.

参见私货: https://github.com/zhongl/config-annotation

为了方便别人使用, 你的库最好支持所属编程语言主流的构建方式进行依赖, 以 Java 为例最好是 Maven 和 Gradle, Scala 则是 SBT.

这里安利一下 jitpack, 使用它可以很容易将一个 Github 上 JVM 库项目自动构建并发布, 远远比往 Maven Central Repository 发布简单.

交代服务是用来解决什么问题的,

罗列服务跑起来最简单的操作步骤,

介绍服务的常用启动参数与配置.

参见私货: https://github.com/zhongl/passport

同样, 为了方便别人快速体验你的服务, 或许提供现成 Docker Image 是个睿智的选择.

Github 生态里有对开源项目免费的 CI/CD 服务, 如 travis-ci.org, circleci.com. 强烈推荐使用它们帮助实现Docker Image 的持续构建与发布.

![Github Badges][]

上图中那些徽章你一定见过. 它们是锦上添花之用, 可以突显项目当前的状态, 增强项目使用者的信心.

如果你是个对代码质量要求比较高的人, 我这里推荐下面的代码状态服务:

travis-ci.org 或 circleci.com

coveralls.io

codacy.com

它们提供漂亮的Badges

Github 在开源社区的建设上, 提供了很多便利的支持, 这里不详细展开, 如果你希望不仅仅是开源一个项目, 而是去打造一个社区, 那么不妨去深挖一下 Github 的官方博客或文档, 你一定会获益良多的.

![Github Community][]

在你的项目页中依次点击 Insights - Community 可见上图.

Enjoy!

The text was updated successfully, but these errors were encountered:

[Github Description]: https://img-blog.csdnimg.cn/img_convert/31d2486a0d66a2955239a7021ece97ad.png
[Github Badges]: https://img-blog.csdnimg.cn/img_convert/aa6a0b933c3298c3f4e5123342fd1f69.png
[Github Community]: https://img-blog.csdnimg.cn/img_convert/5e06d634bd975808bcde77001149282a.png

发表评论取消回复

表情：

评论列表（有 0 条评论，42人围观）

还没有评论，来说两句吧...

相关阅读

相关我在 GitHub 上看到了一个丧心病狂的开源项目！

击蓝色“五分钟学算法”关注我哟加个“星标”，天天中午 12:15，一起学算法 ![640?wx\_fmt=jpeg][640_wx_fmt_jpeg] 作者 | ...

浅浅的花香味﹌/ 2024年04月17日 17:38/ 0 赞/ 48 阅读

相关 GitHub上创建项目

　　Git Bash: 　　1、git clone http://github.com/xxx/xxx.git 　　2、进入项目目录　　3、git checkout -

Dear 丶/ 2023年09月24日 09:14/ 0 赞/ 57 阅读

相关如何在github上创建一个项目

　　以coding.net 为例　　新建git项目并连接到本地　　先在coding.net创建新的代码托管项目　　用ssh建立本地和git的连接　　在git b

墨蓝/ 2023年09月24日 08:59/ 0 赞/ 54 阅读

相关如何在Github上创建一个有逼格的开源项目 · Issue #25 · zhongl／zhongl.github.com · GitHub...

　　首先, 我要感谢 Github 让开源变得如此简单, 简单到只需要有勇气就行. 　　门槛虽然降低了, 只可惜大多数程序猿并没有足够(Hua)严(Xin)肃(Si)对待,

男娘i/ 2023年09月24日 08:58/ 0 赞/ 43 阅读

相关如何在 GitHub 的项目中创建一个分支呢？

　　一、上传一个独立的分支(比如代码是从工程中直接DOWNLOAD ZIP文件如BowlingScore-test.zip，该文件与原MASTER分支是独立的) 　　1、Gi

怼烎@/ 2023年09月24日 08:58/ 0 赞/ 38 阅读

相关使用github上已有的开源项目

如何使用外部的项目 1. 首先下载好github上的项目源码：`https://github.com/wzhe06/ipdatabase.git` 2. 编译下载好的

系统管理员/ 2023年07月20日 08:29/ 0 赞/ 5 阅读

相关 GitHub 上的优质 Linux 开源项目，真滴牛逼！

作为一名互联网人，提起 Linux 大家都不陌生，尤其是日常跟 Linux 操作系统打交道最多的，最熟悉不过了。互联网上关于 Linux 相关的教程和资料也非常的多，但是当你从

拼搏现实的明天。/ 2023年01月06日 05:46/ 0 赞/ 253 阅读

相关如何使用github上的开源项目

以提交的一次开源代码为例，教会你步入开源的世界。 1,首先登陆到[https://github.com][https_github.com]平台上注册一个自己的账号，这个过程

小咪咪/ 2022年06月09日 05:43/ 0 赞/ 890 阅读

相关 Github--Issues

Github Issues 作用：发现代码BUG，但是目前没有成型代码，需要讨论时用；或者使用开源项目出现问题时使用情景：张三发现李四开源git库，提交了一个is

深碍√TFBOYSˉ_/ 2021年08月14日 01:19/ 0 赞/ 325 阅读

相关我在 GitHub 上看到了一个丧心病狂的开源项目！

有人说，写作是少数可随时间推移而不过时的技能之一。但实际情况是，尽管许多人在写作这条道路都做出了尝试，可最终坚持下来的只有极少部分人。在这当中，导致他们放弃或停止写作的最大

╰+攻爆jí腚メ/ 2021年07月31日 17:38/ 0 赞/ 363 阅读