前提
- 熟练使用
Git
,不熟悉的看看我写的这篇文章 - 拥有自己的域名
项目主语言
GitHub通过linguist这个项目自动检测托管在GitHub上面的项目,统计行数最高的为该项目主语言
commit下面的颜色条其实就是该项目的组成部分
点一下,会变成相应的代码统计
我的网站明明是励志型学习网站,怎么会是CSS
呢?简直滑天下之大稽.这个主语言是可以改的.需要结合 gitattributes 的语法,在项目根目录里面添加.gitattributes
文件.
1
2
3
4
5
6
*.css linguist-vendored
*.js linguist-vendored
project-docs/* linguist-documentation
*.rb linguist-language=Java
Api.elm linguist-generated=true
tools/export_bom.py linguist-detectable=false
主要是前2行,后面的内容是凑数的.
参考How to Change Repo Language in GitHub
We found potential security vulnerabilities in your dependencies.
前面已经提到了,GitHub通过linguist这个项目自动检测托管在GitHub上面的项目.出现安全提醒,也是因为被扫描到的文件中,出现了有安全问题的依赖.
我个人当然建议升级涉事的依赖版本.但如果托管的项目我们不想大费周章去改动,那可以使用掩耳盗铃的办法,让linguist别扫描.
办法同样是在项目根目录里面添加.gitattributes
文件,对文件加上linguist-detectable=false
.
1
2
3
*.java linguist-vendored linguist-detectable=false
*.cs linguist-vendored linguist-detectable=false
*.xml linguist-detectable=false
贡献者行为规范(guidelines)
好不容易写了开源项目,托管到GitHub总是有各种沙雕发沙雕issue咋办?当然直接在项目设置里面关掉issue让他们闭嘴啦(大雾~)这个时候可以通过设置guidelines来规范各种酱油党的行为。
- 在项目根目录创建.github文件夹
然后按需创建issue_template.md或pull_request_template.md文件
如果想让酱油党选择建议方式。比如提交bug,功能请愿,则在.github
目录里面创建issue_template
目录,在这个目录里面再创建bug_report.md
,feature_request.md
.具体参考vscode
一般大型开源项目会这么搞,具体的参照
- https://github.com/kubernetes/kubernetes/tree/master/.github
- https://github.com/golang/go/tree/master/.github
各种图章
shields.io
这个徽章相当强大,从构建,项目信息,依赖框架,扯淡聊天什么的,应有尽有。涵盖各种平台,跨越各种依赖。。。
ghbtns.com
为了显示GitHub项目上面的Star
,Watch
,Fork
,Follow
(装逼)数量,可以通过iframe+a标签的方法显示。具体参见GitHub buttons
显示star:
https://ghbtns.com/github-btn.html?user=zeusro&repo=Zeusro.github.io&type=star&count=true
CI
travis-ci
azure dev
扯淡相关
比如加入 gitter
文档相关
[![GoDoc Widget]][GoDoc]
食草动物相关
CII Best Practices
是证明kubernetes是无害项目,弄个这样的徽章也是醉了。。。
Contributors 列表
https://allcontributors.org/
GitHub app ,他们会提供一个机器人自动pull request
https://opencollective.com/
这个有条件的,要 star > 100 才行
GitHub page
GitHub page
是GitHub
支持静态网站托管的一种形式.入口是index.html
推荐几种静态博客生成工具