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


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

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

相关推荐
m0_694845578 小时前
tinylisp 是什么?超轻量 Lisp 解释器编译与运行教程
服务器·开发语言·云计算·github·lisp
June`8 小时前
muduo项目排查错误+测试
linux·c++·github·muduo网络库
weixin_66811 小时前
GitHub 2026年AI项目详细数据汇总表-AI分析-分享
人工智能·github
CoderJia程序员甲1 天前
GitHub 热榜项目 - 日榜(2026-02-05)
ai·开源·大模型·github·ai教程
weixin_6681 天前
GitHub 2026年AI项目热度分析报告-AI分析-分享
人工智能·github
MicrosoftReactor1 天前
技术速递|GitHub Copilot CLI 斜杠命令速查表
github·copilot·cli
wu~9701 天前
GitHub永不遗忘,使用git push -f来覆盖的提交依旧保留
git·github
m0_694845571 天前
music-website 是什么?前后端分离音乐网站部署实战
linux·运维·服务器·云计算·github
独自破碎E1 天前
已经 Push 到远程的提交,如何修改 Commit 信息?
开发语言·github
jiang_changsheng1 天前
工作流agent汇总分析 2
java·人工智能·git·python·机器学习·github·语音识别