老天奶啊,这几天想把我写的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.js和manifest.json 来specify你的项目信息。
Tag
接下来讲到tag。Tag就是你把某个commit拎出来给它一个名字。
Release
有了tag之后,你可以基于这个 tag,给用户一个"可下载的版本",这就是release,是「给用户的交付物」。release里面除了打包好的代码,还可以放一些其他你想让用户一起下载的文件。
比如obsidian plugin就要求release里面要有main.js、manifest.json和style.css。
打完tag之后以及每次commit之后github会进行一个build和verify,这时候先不要马上发布release,不然会报错那个release已经存在,应该等build完之后再发布release。
好啦!很简单的概念对吧,但是我最开始就是绕绕绕没绕明白。
希望我的小插件能尽快和大家见面~