尝试理清楚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。


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

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

相关推荐
犹若故人归1 小时前
Github/Gitee和Git实践
git·gitee·github
无限进步_6 小时前
【C语言&数据结构】二叉树遍历:从前序构建到中序输出
c语言·开发语言·数据结构·c++·算法·github·visual studio
好想来前端10 小时前
私有化部署 LLM 时,别再用 Nginx 硬扛流式请求了 —— 推荐一个专为 vLLM/TGI 设计的高性能网关
后端·架构·github
charlie11451419111 小时前
用 MkDocs + GitHub Actions 自动化部署项目文档
自动化·github
MemOS13 小时前
MemOS 产品更新|支持全量获取用户记忆,记忆管理与对话体验提升
github
恋猫de小郭14 小时前
Compose Multiplatform 1.10 Interop views 新特性:Overlay 和 Autosizing
android·flutter·macos·kotlin·github·objective-c·cocoa
极客小云15 小时前
【增强版 X-AnyLabeling:支持多模态图像对比标注与 YOLO 标签自动导入】
yolo·目标检测·github·语义分割
CoderJia程序员甲1 天前
GitHub 热榜项目 - 日榜(2026-1-13)
人工智能·ai·大模型·github·ai教程
iuu_star1 天前
项目开源-零基础掌握GitHub大文件上传(Git)
开源·github
wangruofeng1 天前
OpenCode 上手初体验:从安装到基础使用
github·ai编程