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

eechen 发布于2019-08-26 14:01 / 1682人阅读

摘要：前言最近在弄自己的项目，这几天将他美化了一下。咱们前端项目不需要后台，真的非常合适部署在上。用于检查项目的是否符合格式。参考项目徽章的添加和设置和编写指南其他当然，后续如果你的项目有其他的人参与进来，一份模板，和模板也是不能少的。

前言

最近在弄自己的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模板也是不能少的。

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

关于我

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

混合云服务器托管表面绘制图像识别表面检测图像识别表面缺陷数据分析这个专业如何

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/109971.html

深入浅出云计算经济学

摘要：在云计算日益成熟和普及的今天，共享经济的理念不断的为人们所理解和接受。作者在书中，提出了云计算经济学的三个核心定律。云计算与自建基础设施哪个更经济这个问题，也是目前比较有争议的。在云计算日益成熟和普及的今天，共享经济的理念不断的为人们所理解和接受。云逐渐由一种技术，演化成了一种商业模式，以及一种经济学现象。Joe Weinman在其大作《云经济学》一书中，创造性地提出了Cloudonomi...

PingCAP 2019-04-25 17:44 评论0 收藏0
我是如何学习游戏引擎的？

摘要：下面列举了游戏开发中常见的岗位以及两条常见的协作开发的流水线其实学习游戏引擎，前期对于任何岗位来说路线都是相似的，基本上就是一个熟悉基本操作理解基本概念拓展专业知识的过程。当然这不是绝对的，任何引擎的开始阶段和大成阶段都是相似的。这是【游戏开发那些事】第51篇原创前言：游戏引擎，表面...

未东兴 2021-09-30 09:48 评论0 收藏0
Android 研发工程师图书一览（2016年版）

摘要：番茄工作法简约而不简单，本书亦然。在番茄工作法一个个短短的分钟内，你收获的不仅仅是效率，还会有意想不到的成就感。 @author ASCE1885的 Github 简书微博 CSDN 知乎本文由于潜在的商业目的，不开放全文转载许可，谢谢！ showImg(/img/remote/1460000007319503?w=728&h=792); 广而告之时间：我的新书《Android 高...

MadPecker 2019-08-14 14:58 评论0 收藏0
如何系统地自学 Python？

摘要：这里推荐一本书源码剖析源码剖析豆瓣这本书把源码中最核心的部分，给出了详细的阐释，不过阅读此书需要对语言内存模型和指针有着很好的理解。　　是否非常想学好 Python，一方面被琐事纠缠，一直没能动手，另一方面，担心学习成本太高，心里默默敲着退堂鼓? 　　幸运的是，Python 是一门初学者友好的编程语言，想要完全掌握它，你不必花上太多的时间和精力。　　Python 的设计哲学之一就是...

zgbgx 2019-07-25 11:36 评论0 收藏0