更新课程作业
This commit is contained in:
parent
3cebdb09c7
commit
f8f58d95ee
|
|
@ -1,5 +1,43 @@
|
|||
> - 有Repo：1分；
|
||||
> - 有README.md： 1分；
|
||||
> - 按要求的commit message：1分；
|
||||
> - 有OSS贡献计划：1分；
|
||||
> - OSS贡献计划体现出对项目的了解和自己的认真思考：1分。
|
||||
# Lab 1：熟悉git和GitHub（7分）
|
||||
|
||||
**截止日期：2022.09.28 11:59am**
|
||||
|
||||
## 实践目的
|
||||
|
||||
熟悉开源软件开发中常用的工具、平台、和开发流程；为课程学习确立初步计划和目标
|
||||
|
||||
## 实践流程
|
||||
|
||||
1. 如果你还没有GitHub账号，请注册一个GitHub账号
|
||||
2. 将GitHub账号以邮件/微信形式发给助教，助教发送GitHub邀请到[OSS-Dev-Course-PKU](https://github.com/OSS-Dev-Course-PKU)组织，Lab 1、Lab 4和Lab5中涉及操作GitHub的部分均会在此进行；此外，后续的课程项目也会以此处告知的GitHub账号为准进行评分
|
||||
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
|
||||
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，用一句话描述贡献想法和计划的变化
|
||||
> 在真实的开源项目中，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
|
||||
> 在Lab 1中，你有直接合并PR的权限；在真实的开源项目中，通常只有核心维护者具有PR合并权限，需要通过一轮或多轮[Code Review](https://en.wikipedia.org/wiki/Code_review)，才能合并PR里的变更
|
||||
|
||||
## 评分标准
|
||||
|
||||
- （1分）按要求创建了repository
|
||||
- （1分）Repository中有README.md
|
||||
- （1分）按要求书写了commit message
|
||||
- （1分）README.md有OSS贡献计划
|
||||
- （1分）按要求open issue
|
||||
- （1分）按要求fork repository、提交commit修改、和提交PR
|
||||
- （1分）贡献想法体现出了对开源项目的了解和自己的认真思考
|
||||
|
||||
## 提交方式
|
||||
|
||||
Lab 1无需特意提交任何内容，助教会在DDL后检查[OSS-Dev-Course-PKU](https://github.com/OSS-Dev-Course-PKU)中是否存在相应仓库、README.md、fork/PR合并记录、和贡献想法，做出最终评分
|
||||
|
||||
## 备注
|
||||
|
||||
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. 在评分标准中，贡献想法的长度**不会**作为评分的参考，简明扼要即可；评分的最终解释权归助教所有
|
||||
|
|
|
|||
|
|
@ -0,0 +1 @@
|
|||
敬请期待
|
||||
|
|
@ -0,0 +1 @@
|
|||
敬请期待
|
||||
|
|
@ -0,0 +1 @@
|
|||
敬请期待
|
||||
|
|
@ -0,0 +1 @@
|
|||
敬请期待
|
||||
|
|
@ -0,0 +1 @@
|
|||
敬请期待
|
||||
|
|
@ -0,0 +1 @@
|
|||
敬请期待
|
||||
|
|
@ -1,2 +1,23 @@
|
|||
# Assignments // 课程作业
|
||||
|
||||
## 实践作业（Labs）
|
||||
|
||||
**主要目的：** 熟悉开源软件项目的开发方式和常见最佳实践
|
||||
|
||||
1. [Lab 1](Lab1.md)：熟悉git和GitHub（7分）
|
||||
2. [Lab 2](Lab2.md)：了解开源项目的开发方式和贡献流程（7分）
|
||||
3. [Lab 3](Lab3.md)：在开源项目中选择开发任务（8分）
|
||||
4. [Lab 4](Lab4.md)：CI/CD流水线搭建（10分）
|
||||
5. [Lab 5](Lab5.md)：Python开源软件包安装/管理/打包/上载（10分）
|
||||
6. [Lab 6](Lab6.md)：Linux Kernel中的沟通实践（8分）
|
||||
|
||||
Labs占期末总评的50分
|
||||
|
||||
## 课程项目（Project）
|
||||
|
||||
**主要目的：** 在实际的开源项目中与开发者沟通、做出贡献，并总结反思整个过程
|
||||
|
||||
1. [Project.md](Project.md)：详细要求及评分标准
|
||||
2. [Report/](Report/)：报告模板
|
||||
|
||||
Project占期末总评的40分
|
||||
|
|
|
|||
16
Syllabus.md
16
Syllabus.md
|
|
@ -9,8 +9,8 @@
|
|||
* 101开源软件概述：开源的定义、历史和现状、社区结构和治理，以及开源研究。 **lecture101**
|
||||
* 102开源参与概述：怎么参与开源项目和社区（如果时间允许，课堂上访问github/gitee/gitlink，设立平台账号，了解一个开源项目）。**lecture102**
|
||||
|
||||
> **Lab 1：练习使用git和GitHub**
|
||||
> - 注册GitHub账号；
|
||||
> **Lab 1：练习使用git和GitHub（7分）**
|
||||
> - 注册GitHub账号
|
||||
> - 加入课程的[Organization](https://github.com/OSS-Dev-Course-PKU)
|
||||
> - 创建GitHub仓库并添加commit，于README.md写下目前的开源项目贡献想法
|
||||
>
|
||||
|
|
@ -36,7 +36,7 @@
|
|||
- criteria to select open source project and task to participate in.
|
||||
- 以1~2个GitHub项目/任务为例，展示如何做贡献（消除畏惧感）.
|
||||
|
||||
> **Lab 2：了解开源项目的开发方式和贡献流程**
|
||||
> **Lab 2：了解开源项目的开发方式和贡献流程（7分）**
|
||||
>
|
||||
> 任意选择一个活跃、成熟的开源项目：
|
||||
> - 了解并报告CONTRIBUTING.md的形式和内容
|
||||
|
|
@ -50,7 +50,7 @@
|
|||
|
||||
## 第5次课：如何选择任务参与，GitHub Good First Issue（课堂lecture） 10/12
|
||||
|
||||
> **Lab 3：探索可以参与的开发任务**
|
||||
> **Lab 3：在开源项目中选择开发任务（8分）**
|
||||
>
|
||||
> - 选择一个或者多个感兴趣的开源项目，探索并报告：
|
||||
> * 是否具有Good First Issue机制
|
||||
|
|
@ -69,7 +69,7 @@
|
|||
|
||||
## 第7次课：CI/CD（上机实习） 10/26
|
||||
|
||||
> **Lab 4：CI/CD流水线搭建**
|
||||
> **Lab 4：CI/CD流水线搭建（10分）**
|
||||
>
|
||||
> 了解三种CI流程管理工具Travis CI、GitHub Actions、Gitee Go, 知道如何使用这些工具编写简单的CI流水线，并且在实践项目上完成符合要求的成功构建
|
||||
>
|
||||
|
|
@ -84,7 +84,7 @@
|
|||
|
||||
## 第9次课：PyPI/NPM等包生态系统/包管理工具，使用/打包/上载软件包（上机实习） 11/9
|
||||
|
||||
> **Lab 5：Python开源软件包安装/管理/打包/上载**
|
||||
> **Lab 5：Python开源软件包安装/管理/打包/上载（10分）**
|
||||
>
|
||||
> - 使用pip进行python包的管理；
|
||||
> - 使用poetry进行python包的管理；
|
||||
|
|
@ -105,7 +105,9 @@
|
|||
|
||||
* 协作和沟通的重要性，如何沟通，分布式沟通中的要点，如何提交PR等。
|
||||
|
||||
> Lab 6： 阅读linux kernel中的沟通实践相关资料，体会总结开源沟通的最佳实践
|
||||
> **Lab 6：Linux Kernel沟通实践（8分）**
|
||||
>
|
||||
> 阅读Linux Kernel中的沟通实践相关资料，体会总结开源沟通的最佳实践（8分）
|
||||
>
|
||||
> - 提交issue时如何参与讨论，如何沟通
|
||||
> - 提交pr时如何沟通
|
||||
|
|
|
|||
Loading…
Reference in New Issue