周报提交指南
MarioLulab opened this issue · 0 comments
Intro
亲爱的营员们👋,
大家好!在我们的护航集训营中,我们要求营员们每两周都要提交周报。周报的提交对我们项目的进展非常重要:
1️⃣ 增加透明度:通过周报,不仅有利于营员更清楚自己的工作内容和目标,也可以让他人了解每个营员的工作进展,使得整个团队的进度更加透明。这有助于我们及时发现并解决问题。
2️⃣ 加强沟通:周报是团队沟通的重要工具。你可以在周报中分享你的工作进展、遇到的问题和解决方案,让我们更好地了解彼此的工作。
3️⃣ 提供反馈机会:周报也为你们提供了一个反馈的机会。你们可以在周报中提出对项目的建议或问题,这有助于我们改进项目流程。
所以,请大家务必每两周按时提交周报哦📝。如果有任何关于周报的问题或者建议,随时在如流里找助教 AndSonder 或者 Paddle 团队的孙师傅 sunzhongkai588 和骆师傅 luotao1 哦~ 🙋♂️🙋♀️
周报提交流程
周报是每一段时间工作的总结提炼,用于更好地反映过去两周的工作成果。提交周报的流程如下:
一、提交前的准备流程
1.1 Fork
先跳转到 PFCCLab/Camp/ GitHub 首页,然后单击 Fork 按钮,生成自己仓库下的目录,比如你的 GitHub 用户名为 USERNAME,则生成: https://github.com/USERNAME/Camp。
1.2 Clone
将你目录下的远程仓库 clone 到本地。
➜ git clone https://github.com/USERNAME/Camp
➜ cd Camp
1.3 创建本地分支
Camp 目前使用 Git 流分支模型进行维护。
「详细周报」的填写工作都应该在一个新的分支上完成,一般从 main 分支上创建新分支。
使用 git checkout -b 创建并切换到新分支。
➜ git checkout -b USERNAME/WeeklyReport
二、正式编写详细周报
营员找到 WeeklyReports/
文件夹下名字为 项目序号_学员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/Hackathon_6h/01_USERNAME/[WeeklyReport]2024.03.1~2024.03.15.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/Hackathon_6h/01_USERNAME/[WeeklyReport]2024.03.1~2024.03.15.md
- 填写提交说明,可以通过 git commit 完成:
➜ git commit -m "USERNAME add 2024.03.1~2024.03.15 WeeklyReport"
3.2 确保本地仓库是最新的
在准备发起 Pull Request 之前,需要同步原仓库 Camp 最新文件内容。
首先通过 git remote 查看当前远程仓库的名字。
➜ git remote
origin
➜ git remote -v
origin https://github.com/USERNAME/Camp (fetch)
origin https://github.com/USERNAME/Camp (push)
这里 origin 是你 clone 的远程仓库的名字,也就是自己用户名下的 Camp,接下来创建一个原始 Camp 仓库的远程主机,命名为 upstream。
➜ git remote add upstream https://github.com/PFCCLab/Camp
➜ git remote
origin
upstream
获取 upstream 的最新代码并更新当前分支。
➜ git fetch upstream
➜ git pull upstream main
3.3 Push 到远程仓库
将本地的修改推送到 GitHub 上,也就是 https://github.com/USERNAME/Camp。
# 推送到远程仓库 origin 的 USERNAME/ 分支上
➜ git push origin USERNAME/WeeklyReport
四、提交 PR & 导师 review
4.1 在自己的代码仓里添加了详细周报后,可以提交 PR 到 https://github.com/PFCCLab/Camp 中
请注意:
- 在创建 PR 时选择 Reviewers 为自己项目的导师,并添加
weekly reports
标签 - 请将周报 PR 按以下格式命名:
[WeeklyReport] USERNAME 2024.mm1.dd1~2024.mm2.dd2
4.2 导师在 pr 中填写周报评价,以 commit 的形式添加在文档中,便于了解推进情况,必要时可为学员调整方向和计划
导师以 commit 的形式将周报点评添加在文档中
4.3 学员提交的周报 PR 会触发周报格式检查
目前的格式检查主要包括:导师是否完成周报点评
格式检查正确的情况下,"Weekly Report Mentor Comment Check" 这一项 check 会通过
导师 approval 后,可以将详细周报 merge 进Camp
五、抽取关键信息,按格式回复周报 issue
学员在 pr 合入后,抽取关键信息,按格式回复周报 issue。这个相当于 pr 的摘要版,便于读者快速了解项目进展和关键信息。戳这里看 Weekly Report issues Demo
周报提交时间
每两周提交一次。具体来说:以两周为一个周期,第二周的周三学员开始创建和编写详细周报的 pr,回复周报 issue,并提醒导师及时进行周报点评;第二周的周五 18:00 前 pr 周报合入
注:第一次周报合入时间为 2024.03.08 ! 也就是学员从 2023.03.06 开始创建和编写周报 pr,原则上 2024.03.08 18:00 前合入。
参考链接