【助教】做业基本要求

提交时间

  • 按时交 - 有分
  • 晚交 - 0分
  • 迟交一周以上 - 倒扣本次做业分数
  • 抄袭 - 倒扣本次做业分数

注:针对迟交的做业,建议先倒扣本次做业分数,学生须要补交完之后联系助教方能修改分数。html

如下是在点评了不少做业之后发现的很常见的问题,有必要总结一下,不然每次都要提一遍(欢迎建议和补充)。

作不到的,将直接倒扣本次做业的分数!

博客中的连接

博客连接必须是能够点击的:git

如:github

博客地址web

或:编程

http://www.cnblogs.com/greyzeng/编程语言

如下两种状况的连接不符合要求:版本控制

  • 连接不可点击,如:

http://www.cnblogs.com/greyzeng/code

  • 连接显示地址和连接实际地址不符合,如:

http://www.cnblogs.com/greyzeng/htm

显示连接为:http://www.cnblogs.com/greyzeng/
实际跳转的连接倒是:https://github.com/greyzengblog

博客中插入代码

博客开头

若是是针对某个做业提交的博客,须要在博客开头注明做业的地址,

格式为:

做业的要求来自于:

http://www.javashuo.com/article/p-xrlttpdi-o.html

若是涉及代码,还须要在博客开头给出存放代码的仓库地址

格式为:

代码所在的github远程仓库的地址:

https://github.com/GreyZeng/calculator

源码提交

不是项目中全部文件都要提交到代码仓库中,
如IDE的配置文件,编译的临时文件夹等都是不要提交到版本控制里面去的,因此项目在提交到版本控制里面的时候要忽略特殊文件

这里是各类类型的编程语言/IDE的gitignore的一些参考模板

规范提交信息说明

提交代码的时候,须要输入本次提交的代码说明(commit message),不少同窗的提交说明都是毫无心义的,如:

如何编写Commit message,请看这个文档
Commit message 和 Change log 编写指南-阮一峰

一个好的例子

关键代码说明

凡是和代码相关的博客,都要有 关键代码 的说明(不是贴全部代码
还要有 程序运行的截图

一个好的例子

团队做业

  • 每一个团队只须要 一个团队博客一个团队代码仓库,团队成员的我的博客没必要每次复制团队博客,团队做业统一提交到团队博客(须要加入班级博客中)中,代码统一提交到团队代码仓库中,每次交做业的时候,只须要附上团队博客和团队代码仓库地址便可。

  • 对于团队代码仓库,每一个团队成员都要有签入代码的记录。

项目的部署运行

不管是我的项目仍是团队项目,都必须有一个文档说明:如何在一台全新的电脑上部署运行大家的程序。

相关文章
相关标签/搜索