Skip to content

Latest commit

 

History

History
36 lines (26 loc) · 1.94 KB

CONTRIBUTION.md

File metadata and controls

36 lines (26 loc) · 1.94 KB

贡献流程

在 github 上

  • 【步骤1】点击仓库右上角的 Fork 图标将仓库 fork 到你自己的账户下

在客户端

  • 【步骤2】将你 fork 的仓库 clone 到本地

  • 【步骤3】新建一个分支(假设分支名为new),并切换到该分支

  • 【步骤4】在你的new分支上修改文章,然后分别执行 git add、git commit 将改动提交到本地库,并记住此次提交的 commit id(假设此次提交生成的commit id 为 9057042)

  • 【步骤5】切换回master分支,先将你本地仓库的master分支与我的仓库同步,依次执行:

    • git remote add tidyjiang8 https://github.com/tidyjiang8/ieee-802.15.4.git(这个步骤只需要执行一次,今后再修改文章时不用执行了)
    • git remote update
    • git merge tidyjiang8
  • 【步骤6】将你在你的新分支上修改的东西合并到 master 分支

    • 执行 git cherry-pick <commit-id>, 即 git cherry-pick 9057042

    合并new分支改动时,我们用git cherry-pick命令,而不是git merge命令,这样的好处是当你的new分支有多次提交时,你可以指定只合并某一次的提交

  • 【步骤7】将你的本地 master 分支 push 到你的远程仓库:git push origin master

在 github 上

  • 【步骤8】进入你的仓库,在仓库下面有个 pull request 链接,点击该链接,然后填写一些说明后提交 PR

在客户端

  • 【步骤9】如果你又想修改新文章,先执行【步骤5】将你本地master与我的仓库同步
  • 【步骤10】切换到你的new分支,将本地master分支的内容合并到new分支:git merge master,然后跳转到【步骤4】依次执行

关于文章格式

源文档采用 markdown 格式(.md),推荐直接使用markdown编辑器编辑文档。

格式的要求:

  • 所有段落段留两个空格
  • 所有的图片已经放到 images 目录下
  • 中文与英文之间、中文与数字之间需要留一个空格