Udacity Code Review Templates

[EthanLin-TWer]

https://github.com/linesh-simplicity/eslint-config-udacity

一般流程

#171

0. 发言 kindness
1. 阅读 rubric，明确所有硬性要求
2. 下载项目
3. 依次评估 rubric 中各个指标，检查通过标准，检查项目是否通过，给出评论

对于每一条详细的代码评论，按照以下套路。

awesome 反馈：

1. 表达出很好的意思
2. 指出好的地方，给出具体的例子
3. (optional) 好在哪里

suggestion / required 反馈：

1. 指出好的地方，如果有
2. 指出需要改进的地方，需要包含：
   2.1 学员的代码现状
   2.2 要求的是什么样，给出官方链接或引用
3. 指出改进的思路或具体方法
4. 就特定话题推荐最佳的学习资料
   4.1 优先推荐 Udacity 已有的课程
   4.2 推荐一手英文资料
   4.3 推荐二手中文资料 中文没有一手
5. 再次鼓励与肯定

具体反馈模板

README 总结 & markdown 语法建议

A README file is included detailing all steps required to successfully run the application.

If you want to prettifier your markdown a little bit, you can consider using more advanced markdown syntax. For example, (A) is related to (B) stuff, so using markdown's (C) syntax here would be more expressive for people to read and understand. Checkout more markdown basics here: https://daringfireball.net/projects/markdown/syntax.

Also checkout our Writing README course for more information on how to write an excellent README that makes your project more professional.

注释问题总结

Comments are present and effectively explain longer code procedures. As a rule of thumb: describe what all custom functions and object methods do.

虽然本质上我认为注释是不好的实践，它意味着自注释代码的失败。

If you are interested in getting deeper into 'comments', having the time wondering when to use comments, when not to and are there alternatives except comments.. then I would recommend some materials for you to go on that journey. Do you know that Robert C.Martin, the co-author of the Agile Manifesto and the author of the book Clean Code, ever says that he 'prefers code that has fewer comments'? Do you want to know why he would have said so and if he's got a point? These materials might going to help you:

• Necessary Comments by Robert C.Martin
• Refactor: Improving the Design of Existing Code by Martin Fowler
• Agile Book Essentials #1: Clean Code by Robert C. Martin
• The Art of Readable Code
• some threads on Stakeoverflow and Reddit about code comments

样式问题总结

Code is formatted with consistent, logical, and easy-to-read formatting as described in the Udacity JavaScript Style Guide.

Styling changes required are commented in the code review area. Please refer to the suggestions and have them fixed :)

You can use lint tools like JSHint or ESLint to help you automatically check for these tiny styling issues so that you can be free to do more important things. You can even integrate it into your pipeline if you are using any of them like Jenkins or Travis.

Also we've developed an ESLint config for Udacity Frontend Nanodegree Style Guide. Consider using it to help you check your styles exactly as what is required by Udacity Frontend Nanodegree Style Guide!

代码整洁、命名建议、方法抽取

You can read more about why naming is important in software engineering and when & how to extract a method through these materials:

• the Extract Methods section of Chapter 6. Composing Methods in Refactoring: Improving the Design of Existing Code by Martin Fowler

[JimmyLv]

卧槽 你当上 Reviewer 了？

[EthanLin-TWer]

没呢，还在考试中。

[EthanLin-TWer]

迟迟不 approve 考试，报酬也一降再降。暂时关闭，以观后效。