我们使用Git来进行版本控制,如果你想为openBSE贡献源代码,你需要了解Git的大致使用方法。此项目目前托管在Github上,所以在贡献代码之前,你需要先拥有一个Github账户。
fork
一份代码到你的代码仓库中;- 贡献你的代码;
- 发起
pull request
申请,并对贡献的代码加以说明,我们会及时处理你的申请,并审核你提交的代码,审查通过后,你的代码将被merge
进我们的仓库中; - 完成以上操作后,你就会自动出现在项目贡献者名单里了。
- 代码需带有适当的注释,以便其他贡献者能看懂你的代码;
- 代码规范,格式工整;
- 提交的代码要遵循MIT许可证,如果你提交的代码有新的依赖,请确保依赖使用的许可证不会和MIT许可证相冲突。
- 提出bug;
- 提出功能改进建议;
- 提出文档补充建议;
- 反馈使用体验。
- 提出修改意见(涉及代码署名和修订追溯问题);
- 发表不友善言论;
- 发表诽谤或侮辱他人的言论;
- 发表具有种族、性别或地域歧视倾向的言论;
- 发表暴力和恐怖主义言论;
- 发表与政治有关的任何话题;
- 进行任何有关色情话题的讨论;
- 任何其他有可能妨害公共利益和伤害他人的言论。
此方法适用于代码微调
- 登录你的GitHub帐号;
- 浏览项目文件,找到要进行修改的文件;
- 点击右上角铅笔图标进行修改;
- 填写
Commit changes
相关内容(Title
必填); 提交修改,等待审核和合并。
如果你需要大量修改或者增加新代码请按照以下方法进行
fork
本项目;- 克隆(
clone
)你fork
的项目到本地; - 新建分支(
ranch
)并检出(checkout
)新分支; - 添加本项目到你的本地
git
仓库作为上游(upstream
); - 进行修改;
- 变基(
rebase
)你的分支到上游master
分支; - push 你的本地仓库到 GitHub;
- 提交
pull request
; - 等待审核,并及时
rebase
你的分支到上游master
分支(若上游master
分支有修改)。
若有必要,可以使用git push -f
强行推送rebase
后的分支到自己的fork
绝对不可以使用git push -f
强行推送修改到上游
- Node.js (npm)
- Visual Studio Code
- GIT GUI (SourceTree、GitHub Desktop)