Update Lab1.md

This commit is contained in:
Hao He 2022-09-07 09:51:48 +08:00 committed by GitHub
parent fc0777ba4f
commit c1f3b1426e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 4 deletions

View File

@ -15,11 +15,12 @@
4. 在自己的个人电脑上安装git初始化一个git repository
> 网上存在大量关于如何在Windows/Mac OS/Linux安装git、初始化git repository、和添加commit的教程可自行搜索参考在此不再赘述除命令行外VS Code等IDE也提供非常便捷的git操作GUI
5. 在repository中创建README.md文件在文件中描述自己目前对开源项目的贡献想法为本学期的课程学习设定目标
6. 在一个新的commit中添加README.md进入git仓库这个commit的commit message应当为`Add README.md`
7. 将这个repository上传到[OSS-Dev-Course-PKU](https://github.com/OSS-Dev-Course-PKU)中你创建的GitHub仓库
8. 建议上过一周课程后再继续这一步相比较于上一次你的贡献想法和计划发生了什么变化请在你创建的GitHub仓库中开启一个issue用一句话描述贡献想法和计划的变化
6. 在一个新的commit中添加README.md进入git仓库这个commit的commit message应当为`Add README.md with my OSS contribution plan`
> 为了保证软件项目的可维护性特别是为了方便他人查看和理解一个项目的开发历史commit message的最低要求通常是**能够简明扼要地总结这个commit所包含的变更**。对于大型项目而言往往还会对commit message格式做出更加严格的要求例如[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)方便对commit进行自动化管理
8. 将这个repository上传到[OSS-Dev-Course-PKU](https://github.com/OSS-Dev-Course-PKU)中你创建的GitHub仓库
9. 建议上过一周课程后再继续这一步相比较于上一次你的贡献想法和计划发生了什么变化请在你创建的GitHub仓库中开启一个issue用一句话描述贡献想法和计划的变化
> 在真实的开源项目中Issue和PR的内容通常会有规定的[模板](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates)以便于维护者快速地处理新的Issue和PR在本Lab中因为相关的issue和PR过于trivial故不对内容作任何要求但是需要额外注意如果在真实的开源项目中提交issue和PR通常需要严格遵循其规定的贡献指南。之后的Lab中涉及到对成熟开源项目的贡献指南的观察和分析
9. 将你创建的GitHub仓库fork到你自己的账号下添加一个或者多个新commit将想法的变化更新在README.md中并对你创建的GitHub仓库开启一个PR设置reviewer为助教等待助教合并PR
10. 将你创建的GitHub仓库fork到你自己的账号下添加一个或者多个新commit将想法的变化更新在README.md中并对你创建的GitHub仓库开启一个PR设置reviewer为助教等待助教合并PR
> 在Lab 1中你有直接合并PR的权限在真实的开源项目中通常只有核心维护者具有PR合并权限需要通过一轮或多轮[Code Review](https://en.wikipedia.org/wiki/Code_review)才能合并PR里的变更
## 评分标准