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

前言

最近在弄本身的github项目，这几天将他美化了一下。因而就有了这篇文章。虽然这些工做不会让你的项目变得牛逼，但会让你的项目变得漂亮，方便了其余人去了解你这个项目

README

README 是用户点进你项目的第一印象，值得你去学习一下如何写readme。固然咱们本身可能考虑的不是很彻底，不如使用工具来生成。推荐readme-md-generator。生成的 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 的工具。

参考

• GitHub 项目徽章的添加和设置
• awesome-bookmarks
• Commit message 和 Change log 编写指南

其余

固然，后续若是你的项目有其余的人参与进来，一份issue 模板，和pr模板也是不能少的。

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

关于我

一个一年小前端，关注个人微信公众号，和我一块儿交流，我会尽我所能，而且看看我能成长成什么样子吧。交个朋友吧！