阅读 6797

如何让你的 GitHub 项目表面上更专业

前言

最近在弄自己的github项目,这几天将他美化了一下。于是就有了这篇文章。虽然这些工作不会让你的项目变得牛逼,但会让你的项目变得漂亮,方便了其他人去了解你这个项目

README

README 是用户点进你项目的第一印象,值得你去学习一下如何写readme。当然我们自己可能考虑的不是很完全,不如使用工具来生成。推荐readme-md-generator。生成的 README 如下图:

项目readme预览

Logo

好的项目第一步就要找一个比较好看得 logo,现在 AI 自动生成 logo 非常火爆。推荐几个网站

  • brandmark
  • looka
  • launchaco,这个是完全免费的,虽然 logo 感觉不太好看
  • designevo,会给你生成一张基础的 logo 图(jpg,和 png),如果你想要更定制的,就要收费了

Badge

在 README 里面,我们可以添加 Badge(徽章),常用的徽标主要有持续集成状态、项目版本信息、代码测试覆盖率、项目支持平台、项目语言、代码分析等,想得到这些徽章的话,知道自己该做些什么了吧。

GITHUB PAGE

用户如果感兴趣,或许会想真切地感受一下项目。咱们前端项目不需要后台,真的非常合适部署在github page上。

Github 彩带

在你的 GITHUB PAGE 上可以添加 Github 彩带,或者 Github Corner

GIT COMMIT

如果你的用户对你的项目特别感兴趣,可能他会看看你的 commit,看看你写代码的过程。如果 commit 信息里面都是 fix , add 甚至 aa,dd 这种无意义的信息,你肯定会觉得这个项目的作者不是特别的用心。

angular的commit规范

当然作为项目的作者,可能有时候真的懒。。。。,为了解决这个问题,推荐大家几个工具。

  • Commitizen 是一个撰写合格 Commit message 的工具。
  • commitlint 用于检查 Node 项目的 Commit message 是否符合格式。

changelog

如果你的所有 Commit 都符合 Angular 格式,那么发布新版本时, Change log 就可以用脚本自动生成,conventional-changelog 就是生成 Change log 的工具。

参考

其他

当然,后续如果你的项目有其他的人参与进来,一份issue 模板,和pr模板也是不能少的。

你有什么花里胡哨的技巧,不妨评论区告诉我吧

关于我

一个一年小前端,关注我的微信公众号,和我一起交流,我会尽我所能,并且看看我能成长成什么样子吧。交个朋友吧!

关注下面的标签,发现更多相似文章
评论