From 6e080d3fdcaf04eaea58de3b217ef3d01a7f2ed4 Mon Sep 17 00:00:00 2001 From: woodrabbit Date: Sun, 4 Aug 2024 16:24:18 +0800 Subject: [PATCH] Update How-to-submit-a-PR.md Optimized some text descriptions. Signed-off-by: woodrabbit --- .../pr/docs/How-to-submit-a-PR/How-to-submit-a-PR.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/primary/pr/docs/How-to-submit-a-PR/How-to-submit-a-PR.md b/primary/pr/docs/How-to-submit-a-PR/How-to-submit-a-PR.md index 1a7190c..ff44314 100644 --- a/primary/pr/docs/How-to-submit-a-PR/How-to-submit-a-PR.md +++ b/primary/pr/docs/How-to-submit-a-PR/How-to-submit-a-PR.md @@ -118,7 +118,7 @@ ```shell git add woodrabbit # 把以自己Gitee-ID命名的文件加入git暂存区 - git commit -s -m "Add woodrabbit file" # 添加了一个以自己Gitee-ID命名的文件 + git commit -s -m "Add a new file" # 添加了一个以自己Gitee-ID命名的新文件 ``` @@ -175,11 +175,11 @@ 填写标题文字和注释，比如标题可以这样写（这个例子将Gitee-ID置于句首是为了在教学活动中方便审阅者看清是谁提交了自己的作业。注意要将*woodrabbit*改成自己的Gitee-ID）： - *woodrabbit - 提交了以自己Gitee-ID命名的文件* + *woodrabbit - 提交了以自己Gitee-ID命名的文件* 注释可以说明此次提交做了哪些改动（及原因）。本例为简单起见是这样写的： - *提交了以自己Gitee-ID命名的文件。* + *提交了以自己Gitee-ID命名的文件。* 为什么要以自己的Gitee-ID命名文件呢？因为这样可以保证提交的文件不重名，代码合入时就不会引发冲突。另外，运行该仓库中的主程序就会将自己的ID打印出来。 @@ -224,17 +224,19 @@ gcc main.c ./a.out ``` -这样，凡是正确提交并被合入PR了的Gitee-ID都可以在电脑屏幕上被打印出来……:) +这样，凡是正确提交并被合入PR了的Gitee-ID都可以在电脑屏幕上被打印出来…… :) ## VI 思考题 + 思考题1：如何给上游开源仓库贡献代码？ 参考答案：如果想给上游开源仓库贡献代码，通常是先fork别人的项目到个人远端仓库，然后在本地修改并提交代码到自己的远端仓库，最后提交PR等待别人合入自己的代码。 思考题2：如何写一个好的PR？ + 参考答案： 1. 一个PR对应一个事情，不要把不同的事情放在一个PR中，保持PR的干净整洁。 -- Gitee