From 423688d54b36c04874eb249da38631fb2a14f50a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=A5=BC=E9=9F=B5=E4=BD=B3?= Date: Tue, 18 Feb 2020 00:29:10 +0800 Subject: [PATCH 01/11] =?UTF-8?q?=E5=88=A0=E9=99=A4=E6=96=87=E4=BB=B6=2007?= =?UTF-8?q?.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- 07.md | 15 --------------- 1 file changed, 15 deletions(-) delete mode 100644 07.md diff --git a/07.md b/07.md deleted file mode 100644 index fc20f69..0000000 --- a/07.md +++ /dev/null @@ -1,15 +0,0 @@ -## ------- - -### 1. - - - - - -### 相关链接 - -* [目录](readme.md) -* 下一章: [四、如何使用项目仓库？](04.md) -* 上一章: [二、“码云”网站的基本使用](02.md) - -- Gitee From 37b6cf02164cf1523c62b7e653254a3f781383ef Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=A5=BC=E9=9F=B5=E4=BD=B3?= Date: Tue, 18 Feb 2020 00:30:24 +0800 Subject: [PATCH 02/11] add 07.md. --- 07.md | 113 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 113 insertions(+) create mode 100644 07.md diff --git a/07.md b/07.md new file mode 100644 index 0000000..c9c07d7 --- /dev/null +++ b/07.md @@ -0,0 +1,113 @@ +## 六、通过 Fork 参与项目完善 +------ + +### 1. 什么是 Fork ？ + +Fork 英文原意是 **叉子**（[单击此处](https://fanyi.baidu.com/?aldtype=85#en/zh/Fork)打开相应的百度翻译网页），可以音译为 **复刻** ，在 Git 中可以意译为 **分叉** 。 + +除了 Fork ，我们下文还会使用到一个 Git 术语： Pull Requests ，在这里 pull 是动词 **拉、拖** 的意思， requests 是名词 **需要、请求** 的意思；因此在 Git 中可以意译为： **请求合并** 。 + +在码云网站中，可以通过 Fork 将别人的项目复制到自己的账号上来；然后对复制的项目内容进行修订————修改别人项目文件中的错误、优化别人项目中的内容；完成这些修订内容并确认正确后，向项目拥有者提交 Pull Requests ，请求将自己的修订内容合并原有的项目中去；项目拥有者根据提交的 Pull Requests ，决定是否合并提交的修订内容到项目中去。 + +由于本文目标读者不是专业程序员，因此以上流程不是通过输入各种 Git 代码完成的，而是直接通过码云网站的网页参与项目的完善。 + + + +### 2. Fork 指定项目仓库 + +要参与项目的完善，首先需要按照前面文章的方法，搜索并打开这个项目网页，如下图所示就是本文接下来要 Fork 的 **项目网页** ： + +![项目网页](https://images.gitee.com/uploads/images/2020/0214/165556_c47017a2_5279685.png "6-1.png") + +(1) 请注意 **项目网页** 的左上角，目前是这个项目创建者（组织）的账号名以及这个项目的名称，后期在 Fork 、 Pull Requests 的时候务必要清楚当前项目到底是自己账号下的，还是创建者账号下的。 + +(2) 确认要 Fork 打开这个项目，只要单击 **项目网页** 右上角的 **Fork** 按钮，就会打开如下图所示的网页： + +![Fork仓库网页](https://images.gitee.com/uploads/images/2020/0214/170401_51bb6eb5_5279685.png "6-2.png") + +* 在 **Fork仓库** 网页中，首先单击选中 Fork 到哪里，一般就是网页中间显示的自己账号头像。 +* 最后单击 **确认** 按钮。 + +选择完 Fork仓库 以后，网站会提示：**当前仓库正在后台处理中，完成后将自动刷新页面** 。 + +如果项目文件不多的话，稍等片刻就会显示如下图所示 Fork 完成后的 **项目网页** ： + +![Fork完成后的项目网页](https://images.gitee.com/uploads/images/2020/0214/171429_090cb014_5279685.png "6-3.png") + +同样请注意观察 Fork 完成后的这个 **项目网页** 的左上角： +* 显示的是当前登录用户的账号（也就是你自己的账号），而不是原来项目创建者的账号名；账号左边的图标也变成了类似 **叉子** 样的，表明这个项目是 Fork 得到的。 +* 项目名称 Fork 完成后没有变化。 +* 右上角 **Fork** 按钮右边的数字在原来的基础上增加了 **1** ，单击这个数字可以在新打开的网页中查看 Fork 这个项目用户的列表。 + + + +### 3. 修改、完善 Fork 项目仓库中的文件 + + Fork 指定项目仓库与在计算机上复制文件夹类似，也是得到了一个与原始项目完全相同的项目仓库副本，无非这个仓库是保存在码云网站自己账号空间里的。 + +对于 Fork 的项目仓库文件，可以根据自己意愿，在默认显示的 **项目** 网页的 **代码** 选项卡中（如下图所示），随意添加、删除文件，修改文件内容，也就是说拥有完全的管理权限： + +![](https://images.gitee.com/uploads/images/2020/0216/101312_d41f903e_5279685.png "6-4.png") + +* 单击 **文件** 按钮，在下拉列表菜单中可以 **新建文件** 、 **新建文件夹** ，还可以 **上传文件** ，将本地文件上传到项目仓库中。 +* 右键单击列表区的文件名，可以打开该文件的 **右键菜单** ，对这个文件进行 **删除** 、 **重命名** 、 **复制** 或者在 **新标签打开** （也就是在新的浏览器标签页中显示这个文件内容）。 +* 左键单击列表区的文件名，则会显示这个文件的内容。在 [第四章 如何下载项目资源？](04.md) 中已有详细介绍，需要特别说明的是，如果打开的是文本格式的文件（比如扩展名为 .md 的 Markdown 文件），可以在 **预览区域** 右上角的菜单栏中找到 **编辑** 按钮（如下图所示），单击这个按钮会进入码云网站提供的 Markdown 编辑器窗口，对文件的文本内容进行编辑（关于码云网站 Markdown 编辑器的使用方法将在后面章节详细介绍）。 + +![输入图片说明](https://images.gitee.com/uploads/images/2020/0216/102848_8c59b7b8_5279685.png "6-5.png") + + + +### 4. 通过 Pull Requests 提交合并请求 + +通过以上步骤，修改的只是自己帐号下的项目仓库文件，而不是原始项目的仓库。也就是说，如果你没有原始项目的相应权限，是不能直接修改原始项目仓库文件的。 + +如果要将自己修改的文件上传到原始项目仓库，参与项目完善工作，在 Git 术语中称之为 **提交合并请求** ，需要通过 Pull Requests 进行操作，具体可以按以下步骤操作： + +(1) 确保已经对 Fork 的项目仓库文件做了必要的修改，并且确认没有错误。 + +(2) 单击 **项目** 网页的 **Pull Requests** 选项卡，打开如下图所示的 **Pull Requests** 选项卡网页，然后单击右上角的 **新建 Pull Requests** 按钮，在选项卡下方显示 **创建 Pull Requests** 网页。 + +![](https://images.gitee.com/uploads/images/2020/0216/112833_7734e430_5279685.png "6-6.png") + +(3) 在如下图所示的 **创建 Pull Requests** 网页中： +* 最上面是 **源分支** 和 **目标分支** ；前者是你自己修改过的项目仓库默认分支，一般默认是 **master** ，后者是你想合并的项目仓库默认分支，是由项目管理员设置的；具体的分支都可以在下拉列表中选择。 +* 在 **创建 Pull Requests** 标签文字右边是网站对这次合并的评估；如果是绿色的 **可自动合并** ，说明要提交的合并内容与项目仓库文件没有冲突，网站可以通过网页方式自动合并；如果不可以自动合并，那就需要使用 Git 命令行方式手工合并，具体的操作方式由于比较复杂，将另行撰写文章介绍。 +* 如果是 **可自动合并** 状态，可以在下方的文本框内输入这次合并的标题；在文本编辑区域输入对这次合并的详细说明；一般需要说明本次请求合并的文件与原仓库文件有什么区别？为什么要请求合并？ +* 如果有必要，还可以在网页右边的 **协作选项** 区域选择需要的协作选项。 +* 最后单击右下角的 **创建** 按钮，提交本次合并请求，会自动打开这个 Pull Requests 的详细内容网页。 + +![](https://images.gitee.com/uploads/images/2020/0216/113752_82b5f5ff_5279685.png "6-7.png") + +(4) 在如下图所示自动打开的 **Pull Requests 内容** 网页中： +* 最上方是这个 Pull Requests 的基本信息。包括左边第一行的 Pull Requests 当前状态、自动编号和标题，第二行的 Pull Requests 分支信息，第三行的 Pull Requests 创建帐号及创建时间，以及最后一行的 Pull Requests 内容说明；右上角是四个工具按钮，可以对这个 Pull Requests 进行相应的操作。 +* 中间是这个 Pull Requests 的互动信息，可以详细了解 Pull Requests 提交及后续的讨论、交流过程。 +* 最下方有三个子选项卡，在 **评论** 子选项中可以提交对当前 Pull Requests 的讨论交流信息，在 **提交** 子选项卡中可以查看这个项目所有提交的合并请求，在 **文件** 子选项卡中可以查看所有发生了变化的项目文件。 + +![](https://images.gitee.com/uploads/images/2020/0216/120816_413c1966_5279685.png "6-8.png") + +> 在 以上第 3 步创建 Pull Requests 网页及第 4 步 Pull Requests 内容网页中，如果注意观察 **项目网页** 左上角的项目账号名称的话，可以发现显示的都是原始项目拥有者的帐号。这说明以上这两步操作都是在原始项目网页中进行的操作，而不是在自己帐号项目里操作。 + + + + +### 5. 等待项目拥有者同意合并 + +合并请求提交以后，是否同意合并是由项目拥有者决定的。 + +项目拥有者会接收到网站自动发送给他的 **通知** ，在他进入到如上图所示的 **Pull Requests 内容** 网页时，可以详细查看、审核 Pull Requests ，决定是否将提交的修订合并到项目仓库中去，还是需要做进一步的交流、讨论，或者干脆关闭这个 Pull Requests ，不合并提交的文件。 + +不管项目拥有者如何处理提交的 Pull Requests ，作为这个 Pull Requests 的提交者，都会通过网站的 **通知** 功能，第一时间收到相应的通知信息。当然也可以随时点击原始项目网页的 **Pull Requests** 选项卡，查看所提交 Pull Requests 的状态（如下图所示）。 + +![](https://images.gitee.com/uploads/images/2020/0216/124742_59d7c178_5279685.png "6-9.png") + +> 请特别注意：必须要进入原始项目仓库查看，而不是自己账号下的项目仓库。 + + + + +### 相关链接 + +* [目录](readme.md) +* 下一章: [七、其它](07.md) +* 上一章: [五、通过 Issue 交流](05.md) + -- Gitee From 6da34cafe641312e78608d9deddee1621d6d47d5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=A5=BC=E9=9F=B5=E4=BD=B3?= Date: Tue, 18 Feb 2020 01:38:01 +0800 Subject: [PATCH 03/11] update 07.md. --- 07.md | 203 ++++++++++++++++++++++++++-------------------------------- 1 file changed, 90 insertions(+), 113 deletions(-) diff --git a/07.md b/07.md index c9c07d7..4fd4f5c 100644 --- a/07.md +++ b/07.md @@ -1,113 +1,90 @@ -## 六、通过 Fork 参与项目完善 ------- - -### 1. 什么是 Fork ？ - -Fork 英文原意是 **叉子**（[单击此处](https://fanyi.baidu.com/?aldtype=85#en/zh/Fork)打开相应的百度翻译网页），可以音译为 **复刻** ，在 Git 中可以意译为 **分叉** 。 - -除了 Fork ，我们下文还会使用到一个 Git 术语： Pull Requests ，在这里 pull 是动词 **拉、拖** 的意思， requests 是名词 **需要、请求** 的意思；因此在 Git 中可以意译为： **请求合并** 。 - -在码云网站中，可以通过 Fork 将别人的项目复制到自己的账号上来；然后对复制的项目内容进行修订————修改别人项目文件中的错误、优化别人项目中的内容；完成这些修订内容并确认正确后，向项目拥有者提交 Pull Requests ，请求将自己的修订内容合并原有的项目中去；项目拥有者根据提交的 Pull Requests ，决定是否合并提交的修订内容到项目中去。 - -由于本文目标读者不是专业程序员，因此以上流程不是通过输入各种 Git 代码完成的，而是直接通过码云网站的网页参与项目的完善。 - - - -### 2. Fork 指定项目仓库 - -要参与项目的完善，首先需要按照前面文章的方法，搜索并打开这个项目网页，如下图所示就是本文接下来要 Fork 的 **项目网页** ： - -![项目网页](https://images.gitee.com/uploads/images/2020/0214/165556_c47017a2_5279685.png "6-1.png") - -(1) 请注意 **项目网页** 的左上角，目前是这个项目创建者（组织）的账号名以及这个项目的名称，后期在 Fork 、 Pull Requests 的时候务必要清楚当前项目到底是自己账号下的，还是创建者账号下的。 - -(2) 确认要 Fork 打开这个项目，只要单击 **项目网页** 右上角的 **Fork** 按钮，就会打开如下图所示的网页： - -![Fork仓库网页](https://images.gitee.com/uploads/images/2020/0214/170401_51bb6eb5_5279685.png "6-2.png") - -* 在 **Fork仓库** 网页中，首先单击选中 Fork 到哪里，一般就是网页中间显示的自己账号头像。 -* 最后单击 **确认** 按钮。 - -选择完 Fork仓库 以后，网站会提示：**当前仓库正在后台处理中，完成后将自动刷新页面** 。 - -如果项目文件不多的话，稍等片刻就会显示如下图所示 Fork 完成后的 **项目网页** ： - -![Fork完成后的项目网页](https://images.gitee.com/uploads/images/2020/0214/171429_090cb014_5279685.png "6-3.png") - -同样请注意观察 Fork 完成后的这个 **项目网页** 的左上角： -* 显示的是当前登录用户的账号（也就是你自己的账号），而不是原来项目创建者的账号名；账号左边的图标也变成了类似 **叉子** 样的，表明这个项目是 Fork 得到的。 -* 项目名称 Fork 完成后没有变化。 -* 右上角 **Fork** 按钮右边的数字在原来的基础上增加了 **1** ，单击这个数字可以在新打开的网页中查看 Fork 这个项目用户的列表。 - - - -### 3. 修改、完善 Fork 项目仓库中的文件 - - Fork 指定项目仓库与在计算机上复制文件夹类似，也是得到了一个与原始项目完全相同的项目仓库副本，无非这个仓库是保存在码云网站自己账号空间里的。 - -对于 Fork 的项目仓库文件，可以根据自己意愿，在默认显示的 **项目** 网页的 **代码** 选项卡中（如下图所示），随意添加、删除文件，修改文件内容，也就是说拥有完全的管理权限： - -![](https://images.gitee.com/uploads/images/2020/0216/101312_d41f903e_5279685.png "6-4.png") - -* 单击 **文件** 按钮，在下拉列表菜单中可以 **新建文件** 、 **新建文件夹** ，还可以 **上传文件** ，将本地文件上传到项目仓库中。 -* 右键单击列表区的文件名，可以打开该文件的 **右键菜单** ，对这个文件进行 **删除** 、 **重命名** 、 **复制** 或者在 **新标签打开** （也就是在新的浏览器标签页中显示这个文件内容）。 -* 左键单击列表区的文件名，则会显示这个文件的内容。在 [第四章 如何下载项目资源？](04.md) 中已有详细介绍，需要特别说明的是，如果打开的是文本格式的文件（比如扩展名为 .md 的 Markdown 文件），可以在 **预览区域** 右上角的菜单栏中找到 **编辑** 按钮（如下图所示），单击这个按钮会进入码云网站提供的 Markdown 编辑器窗口，对文件的文本内容进行编辑（关于码云网站 Markdown 编辑器的使用方法将在后面章节详细介绍）。 - -![输入图片说明](https://images.gitee.com/uploads/images/2020/0216/102848_8c59b7b8_5279685.png "6-5.png") - - - -### 4. 通过 Pull Requests 提交合并请求 - -通过以上步骤，修改的只是自己帐号下的项目仓库文件，而不是原始项目的仓库。也就是说，如果你没有原始项目的相应权限，是不能直接修改原始项目仓库文件的。 - -如果要将自己修改的文件上传到原始项目仓库，参与项目完善工作，在 Git 术语中称之为 **提交合并请求** ，需要通过 Pull Requests 进行操作，具体可以按以下步骤操作： - -(1) 确保已经对 Fork 的项目仓库文件做了必要的修改，并且确认没有错误。 - -(2) 单击 **项目** 网页的 **Pull Requests** 选项卡，打开如下图所示的 **Pull Requests** 选项卡网页，然后单击右上角的 **新建 Pull Requests** 按钮，在选项卡下方显示 **创建 Pull Requests** 网页。 - -![](https://images.gitee.com/uploads/images/2020/0216/112833_7734e430_5279685.png "6-6.png") - -(3) 在如下图所示的 **创建 Pull Requests** 网页中： -* 最上面是 **源分支** 和 **目标分支** ；前者是你自己修改过的项目仓库默认分支，一般默认是 **master** ，后者是你想合并的项目仓库默认分支，是由项目管理员设置的；具体的分支都可以在下拉列表中选择。 -* 在 **创建 Pull Requests** 标签文字右边是网站对这次合并的评估；如果是绿色的 **可自动合并** ，说明要提交的合并内容与项目仓库文件没有冲突，网站可以通过网页方式自动合并；如果不可以自动合并，那就需要使用 Git 命令行方式手工合并，具体的操作方式由于比较复杂，将另行撰写文章介绍。 -* 如果是 **可自动合并** 状态，可以在下方的文本框内输入这次合并的标题；在文本编辑区域输入对这次合并的详细说明；一般需要说明本次请求合并的文件与原仓库文件有什么区别？为什么要请求合并？ -* 如果有必要，还可以在网页右边的 **协作选项** 区域选择需要的协作选项。 -* 最后单击右下角的 **创建** 按钮，提交本次合并请求，会自动打开这个 Pull Requests 的详细内容网页。 - -![](https://images.gitee.com/uploads/images/2020/0216/113752_82b5f5ff_5279685.png "6-7.png") - -(4) 在如下图所示自动打开的 **Pull Requests 内容** 网页中： -* 最上方是这个 Pull Requests 的基本信息。包括左边第一行的 Pull Requests 当前状态、自动编号和标题，第二行的 Pull Requests 分支信息，第三行的 Pull Requests 创建帐号及创建时间，以及最后一行的 Pull Requests 内容说明；右上角是四个工具按钮，可以对这个 Pull Requests 进行相应的操作。 -* 中间是这个 Pull Requests 的互动信息，可以详细了解 Pull Requests 提交及后续的讨论、交流过程。 -* 最下方有三个子选项卡，在 **评论** 子选项中可以提交对当前 Pull Requests 的讨论交流信息，在 **提交** 子选项卡中可以查看这个项目所有提交的合并请求，在 **文件** 子选项卡中可以查看所有发生了变化的项目文件。 - -![](https://images.gitee.com/uploads/images/2020/0216/120816_413c1966_5279685.png "6-8.png") - -> 在 以上第 3 步创建 Pull Requests 网页及第 4 步 Pull Requests 内容网页中，如果注意观察 **项目网页** 左上角的项目账号名称的话，可以发现显示的都是原始项目拥有者的帐号。这说明以上这两步操作都是在原始项目网页中进行的操作，而不是在自己帐号项目里操作。 - - - - -### 5. 等待项目拥有者同意合并 - -合并请求提交以后，是否同意合并是由项目拥有者决定的。 - -项目拥有者会接收到网站自动发送给他的 **通知** ，在他进入到如上图所示的 **Pull Requests 内容** 网页时，可以详细查看、审核 Pull Requests ，决定是否将提交的修订合并到项目仓库中去，还是需要做进一步的交流、讨论，或者干脆关闭这个 Pull Requests ，不合并提交的文件。 - -不管项目拥有者如何处理提交的 Pull Requests ，作为这个 Pull Requests 的提交者，都会通过网站的 **通知** 功能，第一时间收到相应的通知信息。当然也可以随时点击原始项目网页的 **Pull Requests** 选项卡，查看所提交 Pull Requests 的状态（如下图所示）。 - -![](https://images.gitee.com/uploads/images/2020/0216/124742_59d7c178_5279685.png "6-9.png") - -> 请特别注意：必须要进入原始项目仓库查看，而不是自己账号下的项目仓库。 - - - - -### 相关链接 - -* [目录](readme.md) -* 下一章: [七、其它](07.md) -* 上一章: [五、通过 Issue 交流](05.md) - +## 七、为项目编写文本文档 +------ + +### 1. 什么是 README 文件 ？ + +README 文件是让其他用户了解有关你的工作详情的一种快速简单的方式。 +在项目中至少拥有一个 README 文档是一个好主意，因为这是许多人第一次发现你的项目时会首先阅读的内容。 + +如果你需要挖掘项目更深层次的信息，可以用到Wiki。Wiki是一种在网络上开放且可供多人协同创作的超文本系统，Wiki站点可以有多人维护，每个人都可以发表自己的意见，或者对共同的主题进行扩展与探讨。（关于码云网站wiki的使用方法将在后面章节详细介绍） + +### 2. 编辑 README 文档 + +当我们按照前面文章的方法，通过 Fork 得到了一个与原始项目完全相同的项目仓库副本，我们就拥有了完全的管理权限，可以随意添加、删除文件，修改文件内容。 + +鼠标左键单击 README.md 文档，在文档标题的右上角单击 **编辑** 按钮，如下图所示： +![编辑按钮](https://images.gitee.com/uploads/images/2020/0218/011306_35022e62_5678580.jpeg "3.jpg") + **注意：** 这里以编辑 README 文档为例，在实际使用中对于后缀为 ** .md ** 的文档均可以单击进行编辑、修改与完善，如下图所示： +![输入图片说明](https://images.gitee.com/uploads/images/2020/0218/012257_a3fb1568_5678580.jpeg "2.jpg") + +### 3. 格式化 README 文档 + +README 文档通常遵循一种格式，以便使开发人员可以立即定位到项目中最重要的部分。 + + **项目名称：** 你的项目名称是人们在滚动 README 文档时将看到的第一个内容，并且在创建 README 文档时已经包含在内。 + + **描述：** 项目的描述在下面。一个好的描述需要是清晰的，简短的和一针见血的。描述你的项目的重点，以及它的作用。 + + **目录：** （可选的 ->）包含一个目录可以让人们在一篇详细的 README 文档中快速导航。 + + **安装：** 有效的 README 文档的下一个部分是安装。它用于告诉其他用户如何在本地安装你的项目。（可选的 ->）包含一个 gif 动图以便别人可以更清楚该过程。 + + **用法：** 再下一个部分是用法，它用于指导其他用户在安装后将如何使用该项目。在这里，最好包括该项目启动后的屏幕截图。 + + **贡献：** 对于较大的项目来说，通常会有部分章节是概述如何参与项目的说明。有时，这是一个单独的文件。如果你有具体的偏好需求，请解释它们以便其他开发人员指导如何才能最好的参与到你的项目中来。 + + **名单：** 包括一个名单的部分，以突出显示和链接到你的项目的作者。 + +### 3. 文档的内容编写 + + **Markdown** 是一种可以使用普通文本编辑器编写的标记语言，通过简单的标记语法，它可以使普通文本内容具有一定的格式。Markdown的语法简洁明了、学习容易，而且功能比纯文本更强，因此我们通常采用它来写编写文档。 + +Markdown 语法的目标是：成为一种适用于网络的书写语言。 因此，Markdown是兼容Html，HTML 是一种发布的格式，Markdown 是一种书写的格式。就这样，Markdown 的格式语法只涵盖纯文本可以涵盖的范围。不在 Markdown 涵盖范围之内的标签，都可以直接在文档里面用 HTML 撰写。不需要额外标注这是 HTML 或是 Markdown；只要直接加标签就可以了。 + + + + + + + + + + + + + + + + + + + + + + + + + + + +### 5. 等待项目拥有者同意合并 + +合并请求提交以后，是否同意合并是由项目拥有者决定的。 + +项目拥有者会接收到网站自动发送给他的 **通知** ，在他进入到如上图所示的 **Pull Requests 内容** 网页时，可以详细查看、审核 Pull Requests ，决定是否将提交的修订合并到项目仓库中去，还是需要做进一步的交流、讨论，或者干脆关闭这个 Pull Requests ，不合并提交的文件。 + +不管项目拥有者如何处理提交的 Pull Requests ，作为这个 Pull Requests 的提交者，都会通过网站的 **通知** 功能，第一时间收到相应的通知信息。当然也可以随时点击原始项目网页的 **Pull Requests** 选项卡，查看所提交 Pull Requests 的状态（如下图所示）。 + +![](https://images.gitee.com/uploads/images/2020/0216/124742_59d7c178_5279685.png "6-9.png") + +> 请特别注意：必须要进入原始项目仓库查看，而不是自己账号下的项目仓库。 + + + + +### 相关链接 + +* [目录](readme.md) +* 下一章: [七、其它](07.md) +* 上一章: [五、通过 Issue 交流](05.md) + -- Gitee From 0b1e023b1c3cb8852d6bee70a2d230e06e976d6e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=A5=BC=E9=9F=B5=E4=BD=B3?= Date: Tue, 18 Feb 2020 10:57:46 +0800 Subject: [PATCH 04/11] =?UTF-8?q?update=2007.md.=20=E8=BF=9B=E4=B8=80?= =?UTF-8?q?=E6=AD=A5=E5=AE=8C=E5=96=84=E6=96=87=E6=A1=A3=E6=96=87=E6=9C=AC?= =?UTF-8?q?=E7=BC=96=E5=86=99?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- 07.md | 29 ++++++++--------------------- 1 file changed, 8 insertions(+), 21 deletions(-) diff --git a/07.md b/07.md index 4fd4f5c..f96bea7 100644 --- a/07.md +++ b/07.md @@ -14,7 +14,7 @@ README 文件是让其他用户了解有关你的工作详情的一种快速简 鼠标左键单击 README.md 文档，在文档标题的右上角单击 **编辑** 按钮，如下图所示： ![编辑按钮](https://images.gitee.com/uploads/images/2020/0218/011306_35022e62_5678580.jpeg "3.jpg") - **注意：** 这里以编辑 README 文档为例，在实际使用中对于后缀为 ** .md ** 的文档均可以单击进行编辑、修改与完善，如下图所示： + **注意：** 这里以编辑 README 文档为例，在实际使用中对于后缀为 **.md** 的文档均可以单击进行编辑、修改与完善，如下图所示： ![输入图片说明](https://images.gitee.com/uploads/images/2020/0218/012257_a3fb1568_5678580.jpeg "2.jpg") ### 3. 格式化 README 文档 @@ -41,9 +41,15 @@ README 文档通常遵循一种格式，以便使开发人员可以立即定位 Markdown 语法的目标是：成为一种适用于网络的书写语言。 因此，Markdown是兼容Html，HTML 是一种发布的格式，Markdown 是一种书写的格式。就这样，Markdown 的格式语法只涵盖纯文本可以涵盖的范围。不在 Markdown 涵盖范围之内的标签，都可以直接在文档里面用 HTML 撰写。不需要额外标注这是 HTML 或是 Markdown；只要直接加标签就可以了。 +关于Markdown的具体语法及原理，请查看 [Markdown语法及原理从入门到高级](https://blog.csdn.net/weixin_35073408/article/details/100586583?utm_source=app)，学习 Markdown 一文，了解与掌握有关如何修改文件中的文本内容。 +* 如果你是自己新建的文档，不要忘记给你的文档命名，一般文本文档命名。 +* 当然，你可以充分利用文档编辑的工具栏，就在正文上方，功能如我们平常使用的word基本相同，如图所示： +![文档编辑工具栏](https://images.gitee.com/uploads/images/2020/0218/104941_330274d5_5678580.jpeg "5.jpg") +### 4. 确定并提交文本文档 +当我们用 Markdown 的语法编辑好文档以后，想要预览效果如何，可以从 _文档编辑的工具栏_ 中选择 **眼睛** 按钮，或者利用快捷键 **“ctrl+P”** 预览文本编辑效果。 @@ -51,26 +57,7 @@ Markdown 语法的目标是：成为一种适用于网络的书写语言。 因 - - - - - - - - - - - - - - - - -### 5. 等待项目拥有者同意合并 - -合并请求提交以后，是否同意合并是由项目拥有者决定的。 - +** 项目拥有者会接收到网站自动发送给他的 **通知** ，在他进入到如上图所示的 **Pull Requests 内容** 网页时，可以详细查看、审核 Pull Requests ，决定是否将提交的修订合并到项目仓库中去，还是需要做进一步的交流、讨论，或者干脆关闭这个 Pull Requests ，不合并提交的文件。 不管项目拥有者如何处理提交的 Pull Requests ，作为这个 Pull Requests 的提交者，都会通过网站的 **通知** 功能，第一时间收到相应的通知信息。当然也可以随时点击原始项目网页的 **Pull Requests** 选项卡，查看所提交 Pull Requests 的状态（如下图所示）。 -- Gitee From 90e7c209855e5e27ae3cd0b2f2f552616f7c9084 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=A5=BC=E9=9F=B5=E4=BD=B3?= Date: Tue, 18 Feb 2020 11:08:34 +0800 Subject: [PATCH 05/11] =?UTF-8?q?=E6=96=87=E6=A1=A3=E6=96=87=E6=9C=AC?= =?UTF-8?q?=E7=9A=84=E5=88=9D=E6=AD=A5=E7=BC=96=E5=86=99?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- 07.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/07.md b/07.md index f96bea7..92065e7 100644 --- a/07.md +++ b/07.md @@ -49,7 +49,14 @@ Markdown 语法的目标是：成为一种适用于网络的书写语言。 因 ### 4. 确定并提交文本文档 -当我们用 Markdown 的语法编辑好文档以后，想要预览效果如何，可以从 _文档编辑的工具栏_ 中选择 **眼睛** 按钮，或者利用快捷键 **“ctrl+P”** 预览文本编辑效果。 +(1) 当我们用 Markdown 的语法编辑好文档以后，想要预览效果如何，可以从 _文档编辑的工具栏_ 中选择 **眼睛** 按钮，或者利用快捷键 **“ctrl+P”** 预览文本编辑效果。 +(2) 在确定好自己编写的文本文档以后，就需要进行提交的工作，在文档编辑框下方， +* **提交信息：** 在 Git 中，每次提交代码，都要写 Commit message（提交说明），否则就不允许提交。这个操作将通过 git commit 完成。 +* **扩展信息：** 此处填写为什么修改，做了什么样的修改，以及开发者的思路等更详细的信息。 + + + +如图所示： -- Gitee From 2d8625488217cacab854874d927ff660eb29611b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=A5=BC=E9=9F=B5=E4=BD=B3?= Date: Tue, 18 Feb 2020 11:10:35 +0800 Subject: [PATCH 06/11] update 07.md. --- 07.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/07.md b/07.md index 92065e7..05ef837 100644 --- a/07.md +++ b/07.md @@ -53,6 +53,10 @@ Markdown 语法的目标是：成为一种适用于网络的书写语言。 因 (2) 在确定好自己编写的文本文档以后，就需要进行提交的工作，在文档编辑框下方， * **提交信息：** 在 Git 中，每次提交代码，都要写 Commit message（提交说明），否则就不允许提交。这个操作将通过 git commit 完成。 * **扩展信息：** 此处填写为什么修改，做了什么样的修改，以及开发者的思路等更详细的信息。 +* **目标分支：** 单击此处会出现下拉菜单，选择将文本提交至哪一个分支，如果没有新建分支的情况下，默认为 **master** 主分支。 +* **提交：** 此处填写为什么修改，做了什么样的修改，以及开发者的思路等更详细的信息。 + + -- Gitee From 1a8dafccb3eb649d257309115e1ae7f347dcf3a8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=A5=BC=E9=9F=B5=E4=BD=B3?= Date: Tue, 18 Feb 2020 11:39:08 +0800 Subject: [PATCH 07/11] =?UTF-8?q?=E5=85=B6=E4=BB=96?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- 08.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 08.md diff --git a/08.md b/08.md new file mode 100644 index 0000000..e69de29 -- Gitee From c611ee35ea17d68aed3500c0542e5fa2f6095467 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=A5=BC=E9=9F=B5=E4=BD=B3?= Date: Tue, 18 Feb 2020 11:39:19 +0800 Subject: [PATCH 08/11] =?UTF-8?q?=E5=88=9D=E6=AD=A5=E7=BC=96=E5=86=99?= =?UTF-8?q?=E6=96=87=E6=9C=AC=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- 07.md | 32 ++++++++------------------------ 1 file changed, 8 insertions(+), 24 deletions(-) diff --git a/07.md b/07.md index 05ef837..5d492bd 100644 --- a/07.md +++ b/07.md @@ -14,7 +14,8 @@ README 文件是让其他用户了解有关你的工作详情的一种快速简 鼠标左键单击 README.md 文档，在文档标题的右上角单击 **编辑** 按钮，如下图所示： ![编辑按钮](https://images.gitee.com/uploads/images/2020/0218/011306_35022e62_5678580.jpeg "3.jpg") - **注意：** 这里以编辑 README 文档为例，在实际使用中对于后缀为 **.md** 的文档均可以单击进行编辑、修改与完善，如下图所示： +> **注意：** 这里以编辑 README 文档为例，在实际使用中对于后缀为 **.md** 的文档均可以单击进行编辑、修改与完善，如下图所示： +> ![输入图片说明](https://images.gitee.com/uploads/images/2020/0218/012257_a3fb1568_5678580.jpeg "2.jpg") ### 3. 格式化 README 文档 @@ -54,35 +55,18 @@ Markdown 语法的目标是：成为一种适用于网络的书写语言。 因 * **提交信息：** 在 Git 中，每次提交代码，都要写 Commit message（提交说明），否则就不允许提交。这个操作将通过 git commit 完成。 * **扩展信息：** 此处填写为什么修改，做了什么样的修改，以及开发者的思路等更详细的信息。 * **目标分支：** 单击此处会出现下拉菜单，选择将文本提交至哪一个分支，如果没有新建分支的情况下，默认为 **master** 主分支。 -* **提交：** 此处填写为什么修改，做了什么样的修改，以及开发者的思路等更详细的信息。 - - - - - +* **提交：** 单击提交按钮以后，你编辑好的文本文档就能够成功提交到fork过来的仓库中了！ 如图所示： +![确定并提交文本文档](https://images.gitee.com/uploads/images/2020/0218/111943_0e08cce3_5678580.jpeg "6.jpg") +### 4. Pull Request - - - - - -** -项目拥有者会接收到网站自动发送给他的 **通知** ，在他进入到如上图所示的 **Pull Requests 内容** 网页时，可以详细查看、审核 Pull Requests ，决定是否将提交的修订合并到项目仓库中去，还是需要做进一步的交流、讨论，或者干脆关闭这个 Pull Requests ，不合并提交的文件。 - -不管项目拥有者如何处理提交的 Pull Requests ，作为这个 Pull Requests 的提交者，都会通过网站的 **通知** 功能，第一时间收到相应的通知信息。当然也可以随时点击原始项目网页的 **Pull Requests** 选项卡，查看所提交 Pull Requests 的状态（如下图所示）。 - -![](https://images.gitee.com/uploads/images/2020/0216/124742_59d7c178_5279685.png "6-9.png") - -> 请特别注意：必须要进入原始项目仓库查看，而不是自己账号下的项目仓库。 - - +由于刚才编辑和修改的只是自己帐号下的项目仓库文件，而不是原始项目的仓库。如前文所述，[六、通过 Fork 参与项目](06.md)如果要将自己修改的文件上传到原始项目仓库，参与项目完善工作，需要通过 **Pull Requests** 进行操作，以便与原始仓库的文件进行更新与合并。 ### 相关链接 * [目录](readme.md) -* 下一章: [七、其它](07.md) -* 上一章: [五、通过 Issue 交流](05.md) +* 下一章: [八、其它](08.md) +* 上一章: [六、通过 Fork 参与项目完善](06.md) -- Gitee From c8333a2a494ed86907b332011e813713cc8375b4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=A5=BC=E9=9F=B5=E4=BD=B3?= Date: Tue, 18 Feb 2020 11:45:11 +0800 Subject: [PATCH 09/11] =?UTF-8?q?=E6=96=87=E6=9C=AC=E6=96=87=E6=A1=A3?= =?UTF-8?q?=E7=9A=84=E5=88=9D=E6=AD=A5=E7=BC=96=E5=86=99?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- 07.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/07.md b/07.md index 5d492bd..49cebf4 100644 --- a/07.md +++ b/07.md @@ -45,7 +45,8 @@ Markdown 语法的目标是：成为一种适用于网络的书写语言。 因 关于Markdown的具体语法及原理，请查看 [Markdown语法及原理从入门到高级](https://blog.csdn.net/weixin_35073408/article/details/100586583?utm_source=app)，学习 Markdown 一文，了解与掌握有关如何修改文件中的文本内容。 * 如果你是自己新建的文档，不要忘记给你的文档命名，一般文本文档命名。 -* 当然，你可以充分利用文档编辑的工具栏，就在正文上方，功能如我们平常使用的word基本相同，如图所示： +* 当然，你可以充分利用 **文档编辑的工具栏** ，就在正文上方，功能如我们平常使用的Word基本相同，具有 **粗体** 、 _斜体_ 、标题突出 +、插入链接、插入图片、插入表情、插入列表（分为有序列表和无序列表）、插入表格、插入代码、引用的基本功能，如图所示： ![文档编辑工具栏](https://images.gitee.com/uploads/images/2020/0218/104941_330274d5_5678580.jpeg "5.jpg") ### 4. 确定并提交文本文档 @@ -59,9 +60,9 @@ Markdown 语法的目标是：成为一种适用于网络的书写语言。 因 如图所示： ![确定并提交文本文档](https://images.gitee.com/uploads/images/2020/0218/111943_0e08cce3_5678580.jpeg "6.jpg") -### 4. Pull Request +### 5. 通过 Pull Request 提交合并请求 -由于刚才编辑和修改的只是自己帐号下的项目仓库文件，而不是原始项目的仓库。如前文所述，[六、通过 Fork 参与项目](06.md)如果要将自己修改的文件上传到原始项目仓库，参与项目完善工作，需要通过 **Pull Requests** 进行操作，以便与原始仓库的文件进行更新与合并。 +由于刚才编辑和修改的只是自己帐号下的项目仓库文件，而不是原始项目的仓库。如前文所述，[六、通过 Fork 参与项目](06.md)如果要将自己修改的文件上传到原始项目仓库，参与项目完善工作，需要通过 **Pull Requests** 进行操作，以便与原始仓库的文件进行 **更新与合并** 。 ### 相关链接 -- Gitee From fc3dc921664aa4ebb0dfd7ff13a2d8780a47e47d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=A5=BC=E9=9F=B5=E4=BD=B3?= Date: Tue, 18 Feb 2020 11:57:49 +0800 Subject: [PATCH 10/11] =?UTF-8?q?=E6=96=87=E6=9C=AC=E6=96=87=E6=A1=A3?= =?UTF-8?q?=E7=9A=84=E5=88=9D=E6=AD=A5=E7=BC=96=E8=BE=91?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- 07.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/07.md b/07.md index 49cebf4..09a5599 100644 --- a/07.md +++ b/07.md @@ -64,6 +64,13 @@ Markdown 语法的目标是：成为一种适用于网络的书写语言。 因 由于刚才编辑和修改的只是自己帐号下的项目仓库文件，而不是原始项目的仓库。如前文所述，[六、通过 Fork 参与项目](06.md)如果要将自己修改的文件上传到原始项目仓库，参与项目完善工作，需要通过 **Pull Requests** 进行操作，以便与原始仓库的文件进行 **更新与合并** 。 +### 6. 更多 Markdown 语法举例 + +~~文字~~：文字加 **删除线 ** + +符号 - 或 * ，连续3个及以上： **分割线 +** +Markdown 允许段落内的强迫换行（插入换行符）。如果想要 **空一行** ，在插入处先按入两个以上的空格然后回车，即可。 ### 相关链接 -- Gitee From f1187dff45cd812de057023b583ce5c4a098ba1f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=A5=BC=E9=9F=B5=E4=BD=B3?= Date: Tue, 18 Feb 2020 11:59:19 +0800 Subject: [PATCH 11/11] =?UTF-8?q?=E6=96=87=E6=9C=AC=E6=96=87=E6=A1=A3?= =?UTF-8?q?=E7=9A=84=E5=88=9D=E6=AD=A5=E7=BC=96=E8=BE=91?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- 07.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/07.md b/07.md index 09a5599..d137f61 100644 --- a/07.md +++ b/07.md @@ -66,10 +66,10 @@ Markdown 语法的目标是：成为一种适用于网络的书写语言。 因 ### 6. 更多 Markdown 语法举例 -~~文字~~：文字加 **删除线 ** +~~文字~~：文字加**删除线** + +符号 - 或 * ，连续3个及以上：**分割线** -符号 - 或 * ，连续3个及以上： **分割线 -** Markdown 允许段落内的强迫换行（插入换行符）。如果想要 **空一行** ，在插入处先按入两个以上的空格然后回车，即可。 ### 相关链接 -- Gitee