GitHub Repo
之前笔记写了 git 和 gitup(pull+push),这里记一下 giehub repo 二三事。
权限
我不是很确定 github 的企业版是什么样的,不过我们用的是 gitlab 的企业版,这个是需要通过 vpn 才能连接的,如果直接从外网访问的话是没有办法访问我们的 repo 的,github 应该也是差不多的配置吧。
对于个人账户来说权限有两种,public 和 private。public 的 repo 全网可搜,private 只有主人和邀请的合作者才能够访问,这个可以在 repo 里的 settings 进行修改:
将 repo 改成 private 的会丢失所有的 star,之前好像有一个挺有名的 repo 发生过类似的事情,这一点也是需要注意的,最好不要误操作……误操作了 github 也不会帮你还原。
合作者
大多数情况下如果没有加成合作者(collaborators)是没有办法把代码推到对应的 repo 上的(假设当前分支是受保护的,不受保护有办法撅)。这个时候就要加合作者,这样合作者根据权限可以具有访问权和修改权。
这也可以在 settings 里面设置:
readme
reademe 是一个 markdown 文件,github 会自动展示当前页面的 readme 页面,如:
一般来说一个比较好的 readme 会包括:
- 这个项目是做什么的
- 怎么运行这个项目
- 谁会维护这个项目
- 其他信息
每个对应的文件夹下面都可以创建一个 readme,切换到对应的文件夹下会自动显示当前目录下的 readme。
所以说一个 monorepo 的项目中,每个子项目都可以放一个对应的 readme 描述当前项目的一些信息。
readme 的教程很多,我自己也只是使用一些基础功能,这里就不多赘述。
gists
gist 是一用来分享 code snippet 的平台,访问的网址为:https://gist.github.com/,可以理解成一个迷你型的 repo,同样也可以分为 public 和 private。
我个人有的一些 gists 包括:
第一个是用来同步我的 vscode 配置,这样不用换电脑就换一个配置。我偶尔也会找一些分享在 stack overflow 上的 gist,就是一些包含系统配置之类的……
如果设备是 *nix 系统的话,自己保存一些系统配置,这样就不用每次换机器都花几天的时间找以前的配置。
github pages
github pages 是一个用来打包并部署当前静态页面的方法,写好了功能/项目不知道怎么展示?手把手带你白嫖 Git Pages 部署自己的项目去惊艳面试官 里有说具体做法。
这个起名还是太花哨了啊……
不过要注意的是,github pages 只能玩一下前端的部分,后端是没办法运行的。如果要展示后端项目,可能还是得自己弄个服务器比较好。