尝试理清楚Github fork, tag, release和PR

老天奶啊,这几天想把我写的obsidian plugin上架community plugins,没想到尝试了一周还没有成功。因为我是直接fork的obsidian kanban这个repo,然后在它的基础上进行开发,我又是第一次提PR,很多东西都是第一次接触。也算是借着这个机会更了解了github和如何做开源贡献🙏

Fork

在github上如果你看到了一个很棒的项目,想在那个项目的基础上进行开发,或是修改那个项目的bug,你就可以直接fork。

fork = copy那个repo到你的代码仓库。

和clone的区别是clone是copy到本地,而fork是直接在你的代码仓库中新建一个一样的,并且会显示上游的从属关系。

通常来讲,如果你想参与维护一个项目,可以先fork,做完修改之后再提交PR (Pull Request), 项目的维护者决定是否merge你的代码。等你成为contributor后,就可以不用fork,直接新建branch进行修改。

PR (Pull Request)

Obsidian上线community plugin有点不同,你需要fork obsidian-releases这个repo,然后在里面的community-plugins.json加入自己的项目信息。然后提交PR。

json 复制代码
  {  	
    "id": "pomokanban",
  	"name": "Pomokanban",
  	"author": "ahhhh2016",
    "description": "Pomodoro enhanced Kanban plugin with integrated Pomodoro timers, automatic breaks/rounds, and per‑card time logging.",
    "repo": "Ahhhh2016/pomokanban"
  }

它会根据id和repo来识别你的项目。在你的项目里面要确保有main.jsmanifest.json 来specify你的项目信息。

Tag

接下来讲到tag。Tag就是你把某个commit拎出来给它一个名字。

Release

有了tag之后,你可以基于这个 tag,给用户一个"可下载的版本",这就是release,是「给用户的交付物」。release里面除了打包好的代码,还可以放一些其他你想让用户一起下载的文件。

比如obsidian plugin就要求release里面要有main.jsmanifest.jsonstyle.css

打完tag之后以及每次commit之后github会进行一个build和verify,这时候先不要马上发布release,不然会报错那个release已经存在,应该等build完之后再发布release。


好啦!很简单的概念对吧,但是我最开始就是绕绕绕没绕明白。

希望我的小插件能尽快和大家见面~

相关推荐
xuhe24 小时前
[重磅更新] 支持最新 Overleaf 6.x!我的私有化部署方案 xuhe2/sharelatex-ce 迎来大升级
linux·docker·github·科研·overleaf
-拟墨画扇-4 小时前
Git | 状态查看操作
git·gitee·github·gitcode
HelloGitHub5 小时前
《HelloGitHub》第 117 期
开源·github
时光Autistic1 天前
【搭建教程】腾讯混元3D模型部署
开发语言·python·3d·github
Mr-Wanter1 天前
麒麟V10x86 系统 curl报错SSLv3符号缺失问题解决
linux·服务器·github
逛逛GitHub1 天前
推荐 5 个 yyds 的 AI 开源项目,给劲儿啊。
github
邵伯正在输入1 天前
如何同时管理GitLab/GitHub的SSH密钥
ssh·gitlab·github·intellij idea
mike04121 天前
Windows11安装git后与github联动
git·github
lusasky1 天前
AI领域开发TOP开源产品-GitHub-2025
人工智能·开源·github