Module 03 · Final Project and Assessment最终项目与评估
Final Project: Overview and Grading Criteria最终项目:概述及评分标准
Estimated time needed: 15 minutes
所需估计时间:15 分钟
Now that you are equipped with the knowledge and skills to work with GitHub UI and Git CLI, you will use these skills to create an open source project in Git, make changes to that project and make it available to the community. You will fork a GitHub repository, clone that repository to your local system, make changes to the local repository, commit the changes locally, push it back to your GitHub fork, and create a pull request to add your update to the original repository. This final assignment project is split into two parts.
现在你已经掌握了使用 GitHub UI 和 Git CLI 的知识和技能,你将运用这些技能在 Git 中创建一个开源项目,对该项目进行修改,并将其提供给社区。你将分叉一个 GitHub 仓库,将该仓库克隆到本地系统,对本地仓库进行修改,本地提交更改,将其推回你的 GitHub 分叉,并创建一个拉取请求以将你的更新添加到原始仓库。这个最终的项目作业分为两部分。
Part 1 - GitHub UI 第一部分 - GitHub 用户界面
You recently got hired as a developer in a micro-finance startup with a mission to empower and provide opportunities to low income individuals. The core team currently uses Subversion (SVN) for managing code. They want to slowly move their code to Git. You are asked to host their sample code to calculate simple interest on GitHub in a new repository as the first step in this journey. You will not only host the script, but also follow best practices introduced in this course and create supporting documents for the open source project including code of conduct, and contributing guidelines. Additionally, the repository should be available to the community under the Apache License 2.0.
您最近被一家微型金融初创公司聘为开发者,该公司的使命是赋能和为低收入个体提供机会。核心团队目前使用 Subversion(SVN)来管理代码。他们希望逐步将代码迁移到 Git。您被要求在 GitHub 上创建一个新的仓库来托管计算简单利息的示例代码,这是这一旅程的第一步。您不仅要托管脚本,还要遵循本课程中介绍的最佳实践,并为开源项目创建支持性文档,包括行为准则和贡献指南。此外,该仓库应在 Apache License 2.0 许可下对社区开放。
Part 2 - Git CLI 第二部分 - Git 命令行界面
Congratulations on starting the journey with your company by creating an open source Simple Interest Calculator bash script on GitHub. Your changes have been accepted and merged and the company has created a new global repository for the teams to collaborate. Other developers have contributed to this repository over time. Your team has found a mistake in one of the markdown files. You are asked to fork this repository and fix the mistake by using Git CLI in the provided lab environment and open a pull request.
祝贺您通过在 GitHub 上创建开源的简单利息计算器 bash 脚本与公司一起开始这段旅程。您的更改已被接受并合并,公司为团队协作创建了一个新的全球仓库。其他开发者在一段时间内也为这个仓库做出了贡献。您的团队在其中一个 markdown 文件中发现了错误。请您在这个提供的实验室环境中使用 Git CLI 分叉这个仓库并修复错误,然后提交一个 pull request。
Grading Criteria – 20 marks total 评分标准 - 总计 20 分
The final assignment grading criteria for the two parts are as follows:
最终两个部分的作业评分标准如下:
Part 1 GitHub UI (12 points) 第一部分 GitHub UI(12 点)
- Task 1: Submit the URL of the repository (2 pts)
任务 1:提交仓库的 URL(2 分)- 0pts: No URL is submitted.
0 分:未提交 URL。 - 1pt: Valid URL submitted but the URL is empty.
1pt:提交了有效的 URL,但 URL 为空。 - 2pts: Valid URL submitted and the URL has all the files as expected.
2pts:有效的 URL 已提交,且 URL 包含所有预期的文件。
- 0pts: No URL is submitted.
- Task 2: Apache 2.0 License file named LICENSE is present in the repository(2 pts)
任务 2:仓库中存在名为 LICENSE 的 Apache 2.0 许可证文件(2 分)- 0 pts: The repository doesn't have license file.
0 分:仓库中没有许可证文件。 - 1 pt: The repository has a license file, which is different from the specification.
1 pt:存储库有一个许可证文件,这与规范不同。 - 2 pts: The repository has Apache 2.0 license file.
2 分:仓库包含 Apache 2.0 许可文件。
- 0 pts: The repository doesn't have license file.
- Task 3: README.md file is present in the repository. (2 pts)
任务 3:README.md 文件存在于仓库中。(2 分)- 0 pts: The repository doesn't have README file.
0 分:仓库中没有 README 文件。 - 1 pt: The repository has a README file, which is different from the specification or has no content.
1 pt:仓库中有一个 README 文件,与规范不同或没有内容。 - 2 pts: The repository has README.md file as per specification.
2 分:仓库按照规范包含 README.md 文件。
- 0 pts: The repository doesn't have README file.
- Task 4: CODE_OF_CONDUCT file is present in the repository. (2 pts)
任务 4:行为准则文件存在于仓库中。(2 分)- 0 pts: The repository doesn't have CODE_OF_CONDUCT.md file.
0 分:仓库中没有 CODE_OF_CONDUCT.md 文件。 - 1 pt: The repository has a CODE_OF_CONDUCT file, which is different from the specification or has no content.
1 pt:仓库中有一个 CODE_OF_CONDUCT 文件,与规范不同或没有内容。 - 2 pts: The repository has CODE_OF_CONDUCT file as per specification.
2 分:仓库按照规范包含 CODE_OF_CONDUCT 文件。
- 0 pts: The repository doesn't have CODE_OF_CONDUCT.md file.
- Task 5: CONTRIBUTING.md file is present in the repository. (2 pts)
任务 5:CONTRIBUTING.md 文件存在于仓库中。(2 分)- 0 pts: The repository doesn't have CONTRIBUTING.md file.
0 分:仓库中没有 CONTRIBUTING.md 文件。 - 1 pt: The repository has a CONTRIBUTING file, which is different from the specification or has no content.
1 pt:仓库中有一个 CONTRIBUTING 文件,与规范不同或没有内容。 - 2 pts: The repository has CONTRIBUTING file as per specification.
2 分:仓库按照规范包含 CONTRIBUTING 文件。
- 0 pts: The repository doesn't have CONTRIBUTING.md file.
- Task 6: The file
simple-interest.shis present in the repository. (2 pts)
任务 6:文件simple-interest.sh存在于仓库中。(2 分)- 0 pts: The repository doesn't have
simple-interest.shfile.
0 分:仓库中没有simple-interest.sh文件。 - 1 pt: The repository has a
simple-interest.shfile, which is different from the specification or has no content.
1 pt:存储库中有一个simple-interest.sh文件,与规范不同或没有内容。 - 2 pts: The repository has
simple-interest.shfile as per specification.
2 分:根据规范,库中有simple-interest.sh文件。
- 0 pts: The repository doesn't have
Part 2 Git CLI (8 points) 第二部分 Git 命令行界面(8 分)
- Task 1: Submit the URL of the forked repository. (2 pts)
任务 1:提交分叉仓库的 URL。(2 分)- 0 pts: The URL is not submitted or the link doesn't work
0 分:URL 未提交或链接无法工作 - 1 pt: The URL is a valid link but the contents are not forked correctly.
1 pt:该 URL 是一个有效的链接,但内容未正确分支。 - 2 pts: The URL is a valid link and is the fork of the given repository with all the contents.
2 分:该 URL 是一个有效的链接,并且是给定仓库的分支,包含所有内容。
- 0 pts: The URL is not submitted or the link doesn't work
- Task 2: Submit the screenshot of the first merge. (2 pts)
任务 2:提交第一次合并的截图。(2 分)- 0 pts: The image is not submitted
0 分:图片未提交 - 1 pt: The image submitted shows that the branch
bug-fix-typois merged ontomainbut the details are not fully correct.
1 pt:提交的图像显示分支bug-fix-typo已合并到main,但细节并不完全正确。 - 2 pts: The image shows that the current branch is main and changes to
README.mdfile inbug-fix-typohave been merged to main.
2 分:图中显示当前分支为主分支,bug-fix-typo文件中的更改已合并到主分支。
- 0 pts: The image is not submitted
- Task 3: Submit the URL of the pull request. (2 pts)
任务 3:提交拉取请求的 URL。(2 分)- 0 pts: The URL is not submitted
0 分:URL 未提交 - 1 pt: The URL works but doesn't point to the pull request.
1 pt:URL 可以工作,但并未指向拉取请求。 - 2 pts: The URL works and reflects the pull requested which has been accepted.
2 分:URL 正常工作并反映了已接受的拉取请求。
- 0 pts: The URL is not submitted
- Task 4: Submit the URL of the
Branchespage displaying the branch names and their status in your repository. (2 pts)
任务 4:提交显示您仓库中分支名称及其状态的Branches页面的 URL。(2 分)- 0 pts: The URL is not submitted
0 分:URL 未提交 - 1 pt: The URL just shows the number of branches as 3 viz (main, bug-fix-typo and bug-fix-revert), but the details are not evident.
1 pt:URL 仅显示分支数量为 3,即(主分支、bug-fix-typo 和 bug-fix-revert),但细节并不明显。 - 2 pts: The URL shows the branch names and the status.
2 分:URL 显示分支名称和状态。
- 0 pts: The URL is not submitted
Prework: Sign up for GitHub 准备工作:注册 GitHub
Create a GitHub account, if you don't have one already.
创建一个 GitHub 账户,如果您还没有的话。
Next Steps 下一步
Follow the instructions for each part of the lab. You will be prompted to note the URLs into file with an editor for later use in submission. You also have to take screenshot for one of the tasks and save the image as jpg or png. These URLs and images will be uploaded for peer review in the Final Submission section of the course. You can use any editor app to keep note of your URLs.
按照实验室每个部分的说明操作。您将被提示将 URL 记录到文件中,以便稍后用于提交。您还必须为其中一个任务截图,并将图片保存为 jpg 或 png 格式。这些 URL 和图片将在课程的最终提交部分的同行评审部分上传。您可以使用任何编辑器应用来记录您的 URL。