目录

如何写好开源项目的README-自用Git仓库模板分享

自用 Git 仓库模板分享

文章目录

声明:我是 「米司特包」 ,本篇文章 首发 于 「米司博客」 ,其他平台为同步推送(因为可能文章路径会变动,所以就没放详细链接,进来的可以 根据标题查找 🔍)。

本来是要写一篇『如何写好开源项目的 README 的文章的』,后来根据自己的一些项目的情况,就把 CI 和 Issue 模板部分也加了进来

因为平时开发项目找资料,发现有的一些项目代码质量很好,但是因为 README 没写好导致使用者用起来很费劲,有的甚至都没有 README,我自己也经常写 README,所以基于此,我建了个 github 模板库 template-git-repository ,里面包含 『README』 『Issue Template』『Github Actions CI』 三部分,大概的将一个项目所需要的内容都包含了进去。

需要查看源文件的同学,自行前往仓库下载 👇

1. README 部分

README 部分,包含了中英文两部分,针对 Gihutb 和 Gitee 做了中英文渲染测试,效果良好。

1.1 效果截图

1.1.1 Github

https://gitee.com/misitebao/CDN/raw/master/md/image-20210320224317503.png https://gitee.com/misitebao/CDN/raw/master/md/image-20210320224344855.png https://gitee.com/misitebao/CDN/raw/master/md/image-20210320224409815.png https://gitee.com/misitebao/CDN/raw/master/md/image-20210320224442408.png

1.1.2 Gitee

https://gitee.com/misitebao/CDN/raw/master/md/image-20210320224557248.png

2. Issue Template 部分

Issue Template 部分,主要包含了 Bug 和 Features 两部分,也分别做了中英文双语支持,算是一个简单的模板。

2.1 效果截图

https://gitee.com/misitebao/CDN/raw/master/md/image-20210320230746962.png https://gitee.com/misitebao/CDN/raw/master/md/image-20210320230922722.png

3. Github Actions CI 部分

Github Actions CI 部分,主要是我自己平时经常用的一套脚本,这个是我自己一些项目利用 Github Actions 部署到自己服务器上用的脚本,可以大致看下写法 Github Actions 教程请参考官方文档

3.1 效果截图

https://gitee.com/misitebao/CDN/raw/master/md/image-20210320231146893.png https://gitee.com/misitebao/CDN/raw/master/md/image-20210320231241424.png