Update Lab1.md

This commit is contained in:
Hao He 2022-09-07 10:59:05 +08:00 committed by GitHub
parent 5a4780a243
commit 1006795bca
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions

View File

@ -13,7 +13,7 @@
3. 在[OSS-Dev-Course-PKU](https://github.com/OSS-Dev-Course-PKU)中创建一个GitHub仓库名为`2022Fall-{学号}-Lab1`。
> 例如如果学号为2000012345那么仓库名应当为`2022Fall-2000012345-Lab1`。
4. 在自己的个人电脑上安装git初始化一个git repository。
> 网上存在大量关于如何在Windows/Mac OS/Linux安装git、初始化git repository、和添加commit的教程可自行搜索参考在此不再赘述除命令行外VS Code等IDE也提供非常便捷的git操作GUI。
> 网上存在大量关于如何在Windows/Mac OS/Linux安装git、初始化git repository、和添加commit的教程我们在此推荐[MIT的Git教程](https://missing.csail.mit.edu/2020/version-control/)和[Pro Git前五章](https://git-scm.com/book/en/v2),也可自行搜索参考其他教程在此不再赘述除命令行外VS Code等IDE也提供非常便捷的git操作GUI。
5. 在repository中创建README.md文件在文件中描述自己目前对开源项目的贡献想法为本学期的课程学习设定目标。
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进行自动化管理。
@ -41,6 +41,6 @@ Lab 1无需特意提交任何内容助教会在DDL后检查[OSS-Dev-Course-PK
## 备注
1. Lab 1中所涉及的git操作相对比较简单在真实的开源项目中可能会涉及到比较复杂的git操作例如branch/rebase/squash/submodule等因此虽然Lab 1不对此作强制的评分要求但是我们强烈建议如果你对git仍不熟悉可以自己过一遍[MIT的Git教程](https://missing.csail.mit.edu/2020/version-control/),以免在之后的课程项目中遭遇困难。
1. Lab 1中所涉及的git操作相对比较简单在真实的开源项目中可能会涉及到比较复杂的git操作例如branch/rebase/squash/submodule等因此虽然Lab 1不对此作强制的评分要求但是我们强烈建议如果你对git仍不熟悉可以自己过一遍[MIT的Git教程](https://missing.csail.mit.edu/2020/version-control/)并做一做附带的练习,以免在之后的课程项目中遭遇困难。
2. 若上述操作流程中存在误操作或者需要修改贡献想法自行重新提交即可只要仓库历史上存在一个符合要求的commit、issue、fork、PR即符合得分要求。
3. 在评分标准中,贡献想法的长度**不会**作为评分的参考,简明扼要即可;评分的最终解释权归助教所有。