GitHub 作为全球最大的代码托管网站,每天在上面都会产出大量的项目仓库、代码、提交记录。
而据 2018 年的官方统计报告称,GitHub 上已累积超过 9600 万个仓库,2 亿条 pull requests。
由此可见,在如此高密度的代码推送频率下,GitHub 已成为程序员日常工作密不可分的一部分。
如果你是 GitHub 的重度用户,那相信你的账号下面也应该存在多个代码仓库。
当我们重复创建多个代码仓库后,便会突然意识到,在创建仓库的过程中其实做了不少重复性工作。
例如:
为项目创建合适的 .gitignore
编写项目的 README 文档
在不同账户创建多个同类型项目
今天,跟大家分享几个工具,便是要着重解决上述提到的问题。
快速选择 gitignore
在我们平时使用 Git 进行版本管理的时候,为了避免线上托管的项目体积过大,我们一般不会将一些次要文件(如 log、缓存、安装包)等纳入版本管理。
这时,我们会通过创建一个 .gitignore 配置文件,写入特定规则,来指定 Git 忽略追踪某个目录或文件,不将其纳入版本管理,减少线上代码仓库的体积。
由于项目类型不同,要忽略的文件目录自然也不一样。
为此,GitHub 官方开源了一个项目,这个项目为开发者编写好特定的 .gitignore 规则,做成了模板。开发者只需选择好自己的项目类别,将文件内容复制粘贴放到自己项目里面就可以用了。
https://github.com/github/gitignore
在上面,你可以找到目前所有主流语言的 .gitignore 模板。
如果你觉得官方的这个项目用起来还不是很方便,怎么办?
没关系,你还可以用 gitignore.io。
https://www.gitignore.io/
这是由 Uber 一名工程师 joeblau 所开发的 .gitignore 文件快速生成工具,开发者只需要在网站上搜索当前正在使用的操作系统、IDE、编程语言,它便会自动生成一个特定的 .gitignore 配置文件。
如果你不想用网站进行搜索,还可以安装下他的命令行工具。
安装完成后,就可以使用 gi 命令来快速生成 .gitignore 配置文件啦,超级方便!
具体的使用可看下面这个视频:
快速生成 README 文档
如果你觉得写 README 文档是一件特别费时的事,那么,下面的这个项目你应该会喜欢。
最近,一名来自法国的小哥因为饱受重复编写 README 文档的折磨,在 GitHub 上开源了 readme-md-generator 这个工具。
从项目名字便可以知道,它一个 README 文档生成器。其主要作用是通过命令行抓取项目的 package.json 和 git 配置信息,自动完成 README 文档的编写操作。
https://github.com/kefranabg/readme-md-generator
开源的短短半个月时间,该项目便已斩获近 3000 Star,多次上榜 GitHub Trending,由此可见,大家对这个项目很是喜爱。
巧用 GitHub 项目模板
前两周,为了避免开发者做一些无用的重复性工作,GitHub 发布了一个新功能 - 模板仓库(repository templates)。
这个功能可以将以往创建过的仓库标记成模板(template),这样在你下一次创建仓库的时候,就可以使用这个模板功能,快速生成具有和原仓库一样的目录与文件内容。
https://github.blog/2019-06-06-generate-new-repositories-with-repository-templates
每个模板仓库在 URL 末端带上 /generate 后,还可以将模板仓库通过链接分享给其他人,其它人在打开链接之后,便可以快速通过这个模板来创建新仓库。
GitHub 官方还称,未来会在 repo、issue 和 pull requests 中扩展更多模板类型,以避免开发者做一些重复性的工作,将更多精力专注于项目研发上,可以说非常值得期待了。
以上,即为本次分享。
如果觉得本期分享对你有所帮助,还请给个「在看」支持下,谢谢 ♥。
推荐阅读:
「GitHub 交流群」已开放
想入群的可在公众号后台回复「入群」