Skip to content

Instantly share code, notes, and snippets.

@wenqinruan
Last active October 20, 2015 09:38
Show Gist options
  • Save wenqinruan/6f367a932fdf2c26384a to your computer and use it in GitHub Desktop.
Save wenqinruan/6f367a932fdf2c26384a to your computer and use it in GitHub Desktop.
EduSoho Project Checklist

#EduSoho项目checklist

作为一个开发人员,要严格遵循以下的检查清单

####General####

  • 代码是否顺利运行?是否能完成所期望的功能?逻辑是否正确?
  • 所有代码是否容易理解?
  • 代码是否符合编码规范或者代码风格是否统一?
  • 是否存在多余的或者重复的代码?
  • 代码是否尽可能的模块化?
  • 全局变量是否被替换了?
  • 是否存在被注释掉的代码?
  • 循环是否超过变量的长度以及有没有正确的终止循环?
  • 是否还有其他代码可以被库函数所代替?
  • debug代码和输出日志是否还存在?

####Security####

  • 所有输入数据是否被过滤了(类型,长度,格式,边界),还有编码是否在正确?
  • 使用第三方工具,返回错误被捕获了吗?
  • 输出数据是否被过滤以及被编码?
  • 无效的参数处理了吗?

####Testing####

  • 代码是否可测试?例如,不要添加过多的依赖,对象无法初始化,测试框架是否能用你所写的方法.
  • 测试代码是否存在,都覆盖到了吗?例如,至少要达到团队认可的覆盖率.
  • 单元测试是否真实的测试你所要求的功能了吗?
  • 是否测试了数组超出边界的错误?
  • 任何测试代码可以取代现有的API的使用吗?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment