Skip to content

Latest commit

 

History

History
228 lines (149 loc) · 8.14 KB

CONTRIBUTING.md

File metadata and controls

228 lines (149 loc) · 8.14 KB
Raw

贡献代码

欢迎您对MaxKey项目的贡献。 我们诚挚的感谢你的贡献，这个文档描述了我们的工作方式和工作流程，开发者也可以同时参考官方的相关文档。

Workflow

MaxKey开发中使用到的几种模型在这个链接下载 点我.
之后是贡献代码的主要流程。

Fork

  • MaxKey采用Pull Request的方式提交代码，禁止直接push，所有的代码都需要人工review。首先要fork一份MaxKey的代码 "Fork" button.
  • 跳转到MaxKey GitHub首页，然后单击 Fork 按钮，生成自己目录下的仓库，比如 https://github.com/你的用户名/MaxKey。

Clone(克隆)

将远程仓库 clone 到本地：

➜  git clone https://github.com/你的用户名/MaxKey
➜  cd MaxKey

创建本地分支

MaxKey 目前使用Git流分支模型进行开发，测试，发行和维护

所有的 feature 和 bug fix 的开发工作都应该在一个新的分支上完成，一般从 develop 分支上创建新分支。

使用 git checkout -b 创建并切换到新分支。

➜  git checkout -b my-cool-stuff

值得注意的是，在 checkout 之前，需要保持当前分支目录 clean，否则会把 untracked 的文件也带到新分支上，这可以通过 git status 查看。

使用 pre-commit 钩子

MaxKey 开发人员使用 pre-commit 工具来管理 Git 预提交钩子。 在提交（commit）前自动检查一些基本事宜（如每个文件只有一个 EOL，Git 中不要添加大文件等）。

pre-commit测试是单元测试的一部分，不满足钩子的 PR 不能被提交到 MaxKey，首先安装并在当前目录运行它：

pip install pre-commit
pre-commit -v -a

开始开发

在本例中，我删除了 README.md 中的一行，并创建了一个新文件。

通过 git status 查看当前状态，这会提示当前目录的一些变化，同时也可以通过 git diff 查看文件具体被修改的内容。

➜  git status
On branch test
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git checkout -- <file>..." to discard changes in working directory)

	modified:   README.md

Untracked files:
  (use "git add <file>..." to include in what will be committed)

	test

no changes added to commit (use "git add" and/or "git commit -a")

构建

配置环境变量 gradleSetEnv.bat

set JAVA_HOME=D:\JavaIDE\jdk1.8.0_91

set GRADLE_HOME=D:\JavaIDE\gradle-5.4.1

启动构建 gradleBuildRelease.bat

构建结果 构建包路径

MaxKey/build/maxkey-jars

依赖包路径

MaxKey/build/maxkey-depjars

具体开发配置参见 https://maxkey.top/zh/development.html

提交（commit）

接下来我们取消对 README.md 文件的改变，然后提交新添加的 test 文件。

➜  git checkout -- README.md
➜  git status
On branch test
Untracked files:
  (use "git add <file>..." to include in what will be committed)

	test

nothing added to commit but untracked files present (use "git add" to track)
➜  git add test

Git 每次提交代码，都需要写提交说明，这可以让其他人知道这次提交做了哪些改变，这可以通过git commit 完成。

▶ pre-commit run -a -v
[remove-crlf] CRLF end-lines remover........................................Passed
[remove-tabs] Tabs remover..................................................Passed
[check-added-large-files] Check for added large files.......................Passed
[check-merge-conflict] Check for merge conflicts............................Passed
[check-symlinks] Check for broken symlinks..................................Passed
[detect-private-key] Detect Private Key.....................................Passed
[end-of-file-fixer] Fix End of Files........................................Passed
[trailing-whitespace] Trim Trailing Whitespace..............................Passed
[copyright] copyright.......................................................Passed
[clang-format] clang-format.................................................Passed

保持本地仓库最新

在准备发起 Pull Request 之前，需要同步原仓库（https://github.com/MaxKeyTop/MaxKey）最新的代码。

首先通过 git remote 查看当前远程仓库的名字。

➜  git remote
origin
➜  git remote -v
origin	https://github.com/USERNAME/MaxKey (fetch)
origin	https://github.com/USERNAME/MaxKey (push)

这里 origin 是我们 clone 的远程仓库的名字，也就是自己用户名下的 MaxKey，接下来我们创建一个原始 MaxKey 仓库的远程主机，命名为 upstream。

➜  git remote add upstream https://github.com/MaxKeyTop/MaxKey
➜  git remote
origin
upstream

获取 upstream 的最新代码并更新当前分支。

➜  git fetch upstream
➜  git pull upstream develop

Push 到远程仓库

将本地的修改推送到 GitHub 上，也就是 https://github.com/USERNAME/MaxKey。

# 推送到远程仓库 origin 的 my-cool-stuff 分支上
➜  git push origin my-cool-stuff

建立 Issue 并完成 Pull Request

建立一个 Issue 描述问题，并记录它的编号。

切换到所建分支，然后点击 New pull request。

在 PR 的描述说明中，填写 resolve #Issue编号 可以在这个 PR 被 merge 后，自动关闭对应的 Issue

具体请见 https://help.github.com/articles/closing-issues-via-commit-messages/

review

删除远程分支

在 PR 被 merge 进主仓库后，我们可以在 PR 的页面删除远程仓库的分支。

也可以使用 git push origin :分支名 删除远程分支，如：

➜  git push origin :my-cool-stuff

删除本地分支

最后，删除本地分支。

# 切换到 develop 分支
➜  git checkout develop 

# 删除 my-cool-stuff 分支
➜  git branch -D my-cool-stuff

至此，我们就完成了一次代码贡献的过程。

提交代码的一些约定

为了使评审人在评审代码时更好地专注于代码本身，请您每次提交代码时，遵守以下约定：

  1. 请保证单元测试能顺利通过。如果没过，说明提交的代码存在问题，评审人一般不做评审。
  2. 提交Pull Request前：
    • 请注意commit的数量：
      • 原因：如果仅仅修改一个文件但提交了十几个commit，每个commit只做了少量的修改，这会给评审人带来很大困扰。评审人需要逐一查看每个commit才能知道做了哪些修改，且不排除commit之间的修改存在相互覆盖的情况。
      • 建议：每次提交时，保持尽量少的commit，可以通过git commit --amend补充上次的commit。对已经Push到远程仓库的多个commit，可以参考squash commits after push。
    • 请注意每个commit的名称：应能反映当前commit的内容，不能太随意。
  3. 如果解决了某个Issue的问题，请在该Pull Request的第一个评论框中加上：fix #issue_number，这样当该Pull Request被合并后，会自动关闭对应的Issue。关键词包括：close, closes, closed, fix, fixes, fixed, resolve, resolves, resolved，请选择合适的词汇。详细可参考Closing issues via commit messages。

此外，在回复评审人意见时，请您遵守以下约定：

  1. 评审人的每个意见都必须回复（这是开源社区的基本礼貌，别人帮了忙，应该说谢谢）：
    • 对评审意见同意且按其修改完的，给个简单的Done即可；
    • 对评审意见不同意的，请给出您自己的反驳理由。
  2. 如果评审意见比较多：
    • 请给出总体的修改情况。
    • 请采用start a review进行回复，而非直接回复的方式。原因是每个回复都会发送一封邮件，会造成邮件灾难。