贡献指南

通过Github贡献代码

我们使用Git来进行版本控制，如果你想为openBSE贡献源代码，你需要了解Git的大致使用方法。此项目目前托管在Github上，所以在贡献代码之前，你需要先拥有一个Github账户。

贡献代码的方式很简单，你需要：

• fork一份代码到你的代码仓库中；
• 贡献你的代码；
• 发起pull request申请，并对贡献的代码加以说明，我们会及时处理你的申请，并审核你提交的代码，审查通过后，你的代码将被merge进我们的仓库中；
• 完成以上操作后，你就会自动出现在项目贡献者名单里了。

我们希望你贡献的代码符合以下要求：

• 代码需带有适当的注释，以便其他贡献者能看懂你的代码；
• 代码规范，格式工整；
• 提交的代码要遵循MIT许可证，如果你提交的代码有新的依赖，请确保依赖使用的许可证不会和MIT许可证相冲突。

GitHub Issue

我们使用GitHub提供的Issue功能，该功能可以用于：

• 提出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)