使用英语阅读

通过


参与此文档

感谢你对文档的关注!

通过 GitHub 参与

通过 GitHub 参与此文档无需将报告复制到桌面。 这是在存储库中创建拉取请求的最简单的方法。 使用此方法进行不涉及代码更改的少量改动。 使用此方法,一次可以参与一篇文章。

使用 GitHub 参与

  1. 在 GitHub 上找到想要参与的文章。
  2. 进入 GitHub 上的相应文章后,登录 GitHub(获取免费帐户加入 GitHub)。
  3. 选择铅笔图标 (在此项目的分支中编辑文件) ,并在“编辑文件”窗口中进行更改<>
  4. 滚动到底部,输入说明。
  5. 依次选择“建议文件更改”>“创建拉取请求”。

现已成功提交拉取请求。 拉取请求通常在 10 个工作日内完成审核。

通过 Git 参与

通过 Git 参与提供重大更改,例如:

  • 提供代码。
  • 提供影响主旨的更改。
  • 提供对文本的大量更改。
  • 添加新主题。

使用 Git 参与

  1. 如果没有 GitHub 帐户,可通过 GitHub 建立帐户。

  2. 拥有帐户后,在计算机上安装 Git。 按照 [设置 Git] 教程中的步骤操作。

  3. 遵循使用 GitHub、Git 和此存储库中的步骤来通过 Git 提交拉取请求。

  4. 如果你是,系统会要求你签署参与者的许可协议:

    • Microsoft Open Technologies 组的成员。
    • 不在 Microsoft 供职的参与者。

社区成员必须签署参与许可协议 (CLA) 才能向项目提供大量提交内容。 只需完成并提交此文档一次。 请仔细查看该文档。 可能要求你让你的员工签署此文档。

签署此 CLA 并未授予你操纵主存储库的权利,但确实表示 Office 开发人员和 Office 开发人员内容发布团队可以查看并批准你提供的内容。 针对提供的内容,将获得相应奖励。

拉取请求通常在 10 个工作日内完成审核。

使用 GitHub、Git 和此存储库

备注

本部分中的大多数信息都可以在 [GitHub 帮助] 文章中找到。 如果熟悉 Git 和 GitHub,请跳至参与和编辑内容部分,了解此存储库的代码/内容流的具体详情。

设置存储库分支的具体步骤

  1. 建立 GitHub 帐户以参与此项目。 如果还未进行此操作,请转至 GitHub 立即进行。

  2. 在计算机上安装 Git。 按照 [设置 Git] 教程中的步骤操作。

  3. 对此存储库创建你自己的分叉。 为此,请在页面顶部选择“ 分叉 ”按钮。

  4. 将自己的分叉复制到计算机上。 打开 Git Bash 以完成此步骤。 在命令提示符处输入以下命令:

    git clone https://github.com/<your user name>/<repo name>.git

  5. 然后,通过输入以下命令来创建对根库的引用:

        cd <repo name>
        git remote add upstream https://github.com/OfficeDev/<repo name>.git
        git fetch upstream

祝贺你! 现已设置好存储库。 无需再次重复上述步骤。

参与和编辑内容

若要使参与过程无缝进行,请遵循以下步骤。

参与和编辑内容

  1. 新建分支。
  2. 添加新内容或编辑现有内容。
  3. 向主存储库提交拉取请求。
  4. 删除分支。

重要提示:将每个分支限制为单个概念/文章,以简化工作流并减少合并冲突的可能性。 适用于新分支的内容包括:

  • 新文章。
  • 拼写和语法编辑。
  • 对大量文章应用单个格式更改(例如,应用新的版权页脚)。

新建分支

  1. 打开 Git Bash。
  2. 在 Git Bash 命令提示符中键入 git pull upstream main:<new branch name>。 这会在本地创建一个新分支,该分支从最新的 OfficeDev main 分支复制。
  3. 在 Git Bash 命令提示符中键入 git push origin <new branch name>。 此操作将对 GitHub 提示该新分支。 现在将可以在 GitHub 的存储库分叉上看到新分支。
  4. 在 Git Bash 命令提示符中键入 git checkout <new branch name> 以转至新分支。

添加新内容或编辑现有内容

通过使用文件资源管理器导航至计算机上的存储库。 存储库文件位于 C:\Users\<yourusername>\<repo name>

若要编辑文件,请在自己选择的编辑器中将其打开并进行修改。 若要新建文件,请使用自己选择的编辑器并将新文件存储在本地存储库副本中的适当位置。 执行操作期间,经常保存进行的操作。

C:\Users\<yourusername>\<repo name> 中的文件是你在本地存储库中创建的新分支的工作副本。 提交更改前,在此文件夹的任何更改都不会影响本地存储库。 若要向本地存储库提交更改,在 GitBash 中键入以下命令:

    git add .
    git commit -v -a -m "<Describe the changes made in this commit>"

命令 add 会将更改添加到暂存区域,以准备将它们提交到存储库。 命令后面的 add 时间段指定要暂存添加或修改的所有文件,以递归方式检查子文件夹。 (如果不想提交所有更改,可以添加特定文件。还可以撤消提交。有关帮助,请键入 git add -helpgit status.)

命令 commit 将暂存更改应用于存储库。 开关表示你正在向命令行提供要提交的注释。 -v 和 -a 开关可以忽略。 -v 开关用于命令的详细输出,-a 执行添加命令已执行的操作。

参与期间可以多次提交,也可结束参与后一次性提交。

向主存储库提交拉取请求

结束参与准备将其合并到主存储库时,请遵循以下步骤。

向主存储库提交拉取请求

  1. 在 Git Bash 命令提示符中键入 git push origin <new branch name>。 在本地存储库中,origin 代表从其中复制本地存储库的 GitHub 存储库。 此命令将新分支的当前状态(包括上述步骤中的所有提交)推送到 GitHub 分叉。
  2. 在 GitHub 网站上,从自己的分叉中导航到新分支。
  3. 选择页面顶部的“拉取请求”按钮。
  4. 验证基本分支是否是 OfficeDev/<repo name>@main 且头分支是否是 <your username>/<repo name>@<branch name>
  5. 选择“更新提交范围”按钮。
  6. 向拉取请求添加标题,然后说明进行的所有更改。
  7. 提交拉取请求。

其中一个网站管理员将处理你的拉取请求。 拉取请求将出现在 OfficeDev/存储库名称 网站“问题”下。 接受拉取请求后,将解决此问题。

合并后新建分支

分支成功合并后(即已接受拉取请求),不能继续在该本地分支中操作。 这会导致提交其他拉取请求时出现合并冲突。 若要进行其他更新,从已成功合并的上游分支中新建本地分支,然后删除最初的本地分支。

例如,如果本地分支 X 已成功合并到 OfficeDev/microsoft-graph-docs main 分支,并且你希望对合并的内容进行其他更新。 从 OfficeDev/microsoft-graph-docs main 分支创建新的本地分支 X2。 若要实现此操作,请打开 GitBash,然后执行以下命令:

    cd microsoft-graph-docs
    git pull upstream main:X2
    git push origin X2

现在,在分支 X 中提交的工作) ,新的本地分支 (本地副本。X2 分支还包含其他编写器已合并的所有工作,因此,如果你的工作依赖于其他人的工作 (例如共享映像) ,则新分支中可以使用它。 可以通过签出新分支来验证以前的工作 (和其他人的工作) 是否在分支中...

git checkout X2

...并验证内容。 (命令checkout将中的文件C:\Users\<yourusername>\microsoft-graph-docs更新为 X2 branch 的当前状态。) 检查新分支后,可以像往常一样对内容进行更新并提交它们。 但是,为了避免错误地使用合并的分支 (X) ,最好将其删除 (请参阅以下 删除分支 部分) 。

删除分支

成功将更改并入主存储库后,将已使用的分支删除,因为将无需再使用该分支了。 其他任何操作都应在新分支中完成。

  1. 在 Git Bash 命令提示符中键入 git checkout main。 这将确保你不在即将删除的分支中(不允许在即将删除的分支中)。
  2. 接下来,在命令提示符处键入 git branch -d <branch name>。 仅当已成功合并到 上游 存储库时,才会删除计算机上的分支。 (可以使用 标志替代此行为 –D ,但首先请确保要执行此操作。)
  3. 最后,在命令提示符中键入 git push origin :<branch name>(冒号前有一个空格,之后没有空格)。 这将删除 github 分叉中的分支。

恭喜!你已成功参与此项目!

使用 Markdown 设置主题的格式

Markdown

此存储库中的所有文章都使用 Markdown。 可以在 [Daring Fireball - Markdown] 中找到 (和所有语法) 的完整简介和列表。

特定于此存储库的标记约定 & 规则

请参阅我们的参与者指南中的 Docs Markdown 参考

常见问题

如何获取 GitHub 帐户?

填写加入 GitHub 中的表格,以开立免费 GitHub 帐户。

从何处获取参与者许可协议?

系统会自动向你发送通知,指出如果你的拉取请求需要签署参与者的许可协议 (CLA) 。

社区成员必须签署参与许可协议 (CLA) 才能向项目提供大量提交内容。 只需完成并提交此文档一次。 请仔细查看该文档。 可能要求你让你的员工签署此文档。

会如何处理我的参与内容?

提交更改后,会通过拉取请求通知我们的团队,然后会对你的拉取请求进行审核。 你将收到来自 GitHub 的拉取请求通知;如果需要更多信息,我们团队中的某人也可能会通知你。 如果拉取请求获得批准,我们将更新文档。 我们保留出于合法性、风格、简洁性或其他的问题对你的提交内容进行编辑的权利。

我能成为此存储库的 GitHub 拉取请求的审批者吗?

目前,我们不允许外部参与者对此存储库中的拉取请求进行审批。

我多久能获得对我的更改请求的回复?

拉取请求通常在 10 个工作日内完成审核。

更多资源

  • 若要了解有关 Markdown 的详细信息,请转到 Markdown 创建者的网站 [Daring Fireball]。
  • 若要了解有关使用 Git 和 GitHub 的详细信息,请先检查 [GitHub 帮助]。

GitHub HomeGitHub 帮助设置 GitDaring Fireball - MarkdownDaring Fireball