【助教】作业基本要求
提交时间
- 按时交 - 有分
- 晚交 - 0分
- 迟交一周以上 - 倒扣本次作业分数
- 抄袭 - 倒扣本次作业分数
注:针对迟交的作业,建议先倒扣本次作业分数,学生需要补交完以后联系助教方能修改分数。
以下是在点评了很多作业以后发现的很常见的问题,有必要总结一下,否则每次都要提一遍(欢迎建议和补充)。
做不到的,将直接倒扣本次作业的分数!
博客中的链接
博客链接必须是可以点击的:
如:
或:
http://www.cnblogs.com/greyzeng/
以下两种情况的链接不符合要求:
- 链接不可点击,如:
http://www.cnblogs.com/greyzeng/
- 链接显示地址和链接实际地址不符合,如:
http://www.cnblogs.com/greyzeng/
显示链接为:http://www.cnblogs.com/greyzeng/
实际跳转的链接却是:https://github.com/greyzeng
博客中插入代码
- 代码不能截图
- 在博客中插入代码的方式
参考【助教】关于代码提交相关注意事项 - 更多作业排版格式见:博客格式的详细说明
博客开头
如果是针对某个作业提交的博客,需要在博客开头注明作业的地址,
格式为:
作业的要求来自于:
https://www.cnblogs.com/greyzeng/p/9581624.html
如果涉及代码,还需要在博客开头给出存放代码的仓库地址
格式为:
代码所在的github远程仓库的地址:
https://github.com/GreyZeng/calculator
源码提交
不是项目中所有文件都要提交到代码仓库中,
如IDE的配置文件,编译的临时文件夹等都是不要提交到版本控制里面去的,所以项目在提交到版本控制里面的时候要忽略特殊文件
这里是各种类型的编程语言/IDE的gitignore
的一些参考模板
规范提交信息说明
提交代码的时候,需要输入本次提交的代码说明(commit message),很多同学的提交说明都是毫无意义的,如:
如何编写Commit message,请看这个文档
Commit message 和 Change log 编写指南-阮一峰
一个好的例子
关键代码说明
凡是和代码相关的博客,都要有 关键代码 的说明(不是贴所有代码)
还要有 程序运行的截图
一个好的例子
团队作业
-
每个团队只需要 一个团队博客 和 一个团队代码仓库,团队成员的个人博客不必每次复制团队博客,团队作业统一提交到团队博客(需要加入班级博客中)中,代码统一提交到团队代码仓库中,每次交作业的时候,只需要附上团队博客和团队代码仓库地址即可。
-
对于团队代码仓库,每个团队成员都要有签入代码的记录。
项目的部署运行
无论是个人项目还是团队项目,都必须有一个文档说明:如何在一台全新的电脑上部署运行你们的程序。
本文来自博客园,作者:Grey Zeng,转载请注明原文链接:https://www.cnblogs.com/greyzeng/articles/9784978.html