Skip to content

How to contribute

Orangii edited this page Apr 24, 2021 · 1 revision

其实吧,我也不是很清楚怎么才能在别人的仓库中提交代码(contribute),唯一一次提交还被close了

大概流程就是先Fork再修改再commit再创建pull request吧

-1. 代码提交要求

不需要一定有各种乱七八糟的格式化注释(如果有那肯定是更好),但是如果有用户需要自行修改的地方,需要有注释标出,并在Wiki中修改。

提交的内容中不能包含广告、商业推广、个人信息、无版权资料、恶意脚本等影响用户使用或推广性内容,例如出现 by @Jiaocz 等,但是可以在CONTRIBUTION.md中添加你的介绍信息。

当然,也不能恶意提交,比如删了README.md之类的。

0. 可以先看看大家有什么意见没

你可以去某个叫做contribute的地方查看有没有被标上 good first issue 的issue,或者直接去Issues里面看看有没有希望新功能的(虽然我也不知道这么一个小仓库会有谁来提意见和新功能需求)。

1. Fork项目并修改

点仓库首页右上角的Fork将项目Fork到你的仓库,并在本地进行修改然后提交到你Fork下来的你的仓库。

这个时候你提交的都是在你账号下的同名仓库(因为理论上是不能直接提交到本仓库的),完成后可以在你的本地或仓库建立Github Pages查看效果。

2. 建立Pull request

回到本仓库,点击上方的Pull requests,创建PR,选择你的本地仓库和分支、需要提交的目的仓库及分支,之后确认一下修改的内容,附上留言或者必要的信息,等待管理员评审后就可以了。不一定确保通过但支持好的想法。