周报提交指南

[chenjjcccc]

Intro

亲爱的营员们 👋，

大家好！在我们的启航计划集训营中，我们要求营员们每两周都要提交双周周报。双周周报的提交对我们项目的进展非常重要：

1️⃣ 提供任务完成率：通过周报，能帮助营员更加清楚自己的开发进度和目标，督促自己以此保证整个集训期间的任务完成情况。

2️⃣ 加强沟通：周报是团队沟通的重要工具。你可以在周报中分享你的工作进展、遇到的问题和解决方案，让集训营的同学之间更好地了解彼此的工作。

3️⃣ 提供反馈机会：周报也为你们提供了一个反馈的机会。你们可以在周报中提出对项目的建议或问题，这有助于我们改进项目流程。

所以，请大家务必每两周按时提交周报哦 📝。如果有任何关于周报的问题或者建议，随时在找助教 @smallpoxscattered 或者 Paddle 团队的尤师傅 @Harryoung 和涛姐 @luotao1 哦~ 🙋‍♂️🙋‍♀️

周报提交流程

周报是每一段时间工作的总结提炼，用于更好地反映过去两周的工作成果。提交周报的大致流程为：

1. 按模板格式提交双周周报 PR
2. 在每次双周周报 Issue 下进行登记。

具体详细流程如下：

一、提交前的准备流程

1.1 Fork
先跳转到 PFCCLab/Starter/ GitHub 首页，然后单击 Fork 按钮，生成自己仓库下的目录，比如你的 GitHub 用户名为 USERNAME，则生成： https://github.com/USERNAME/Starter。

1.2 Clone
将你目录下的远程仓库 clone 到本地。

➜ git clone https://github.com/USERNAME/Starter.git
➜ cd Starter

1.3 创建本地分支
Starter 目前使用 Git 流分支模型进行维护。

「详细周报」的填写工作都应该在一个新的分支上完成，一般从 main 分支上创建新分支。

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

➜ git checkout -b USERNAME/WeeklyReport

二、正式编写详细周报

营员找到 Reports/season 2 文件夹下名字为 学员GitHubID 的子文件夹(没有需新建)，然后按命名格式

[WeeklyReport]2024.mm1.dd1~2024.mm2.dd2.md

新建文件，编写「详细周报」。可参考模板编写周报：

### 姓名

xxx

### 开发中的快乐开源任务

xxx

### 本双周工作

1. **任务 X**

   - xxx
   - xxx

2. **任务 Y**

   - xxx
   - xxx:
     1. xxx
     2. xxx
     3. xxx

3. **问题疑惑与解答**

   - 问题 a？

     答：xxx

   - 问题 b？

     答：xxx

### 未来双周计划

1. xxx
2. xxx
3. xxx

三、提交 & push

3.1 提交

• 假如修改/新增了 WeeklyReports/USERNAME/[WeeklyReport]2023.09.12~2023.09.23.md 文件，并提交这个文件

➜  git status
On branch USERNAME/WeeklyReport
Changes not staged for commit:
(use "git add <file>..." to update what will be committed)
(use "git restore <file>..." to discard changes in working directory)
no changes added to commit (use "git add" and/or "git commit -a")

➜  git add WeeklyReports/USERNAME/[WeeklyReport]2023.09.12~2023.09.23.md

• 填写提交说明，可以通过 git commit 完成：

➜  git commit -m "USERNAME add 2023.09.12~2023.09.23 WeeklyReport"

3.2 确保本地仓库是最新的
在准备发起 Pull Request 之前，需要同步原仓库 Starter 最新文件内容。

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

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

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

➜  git remote add upstream https://github.com/PFCCLab/Starter
➜  git remote
origin
upstream

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

➜  git fetch upstream
➜  git pull upstream main

3.3 Push 到远程仓库
将本地的修改推送到 GitHub 上，也就是 https://github.com/USERNAME/Starter。

# 推送到远程仓库 origin 的 USERNAME/ 分支上
➜  git push origin USERNAME/WeeklyReport

四、提交 PR

4.1 在自己的代码仓里添加了详细周报后，可以提交 PR 到 https://github.com/PFCCLab/Starter 中
首先跳转到自己的github仓库Starter项目下，点击 Compare & pull requests

Important

• 在创建 PR 时选择 Reviewers 为各专项团导师或助教 ，并添加 weekly reports 标签
• 请将周报 PR 按以下格式命名:

[WeeklyReport] USERNAME 2023.mm1.dd1~2023.mm2.dd2

4.3 学员提交的周报 PR 后，等待导师或助教检查并合入Starter
助教检查后，可以将详细周报 merge 进Starter

五、抽取关键信息，按格式回复周报 issue

学员在 pr 合入后，抽取关键信息，按格式回复周报 issue。这个相当于 pr 的摘要版，便于读者快速了解项目进展和关键信息。戳这里看 Weekly Report issues Demo

周报提交时间

每两周提交一次。

---

参考链接

1. https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/dev_guides/docs_contributing_guides_cn.html