Work outline for Summer 2017 - AutolabJS/autolabcli GitHub Wiki
Work Description | Deadline | status | Collaborator |
---|---|---|---|
travis with eslint and eslintrc | complete | Utkarsh Rai | |
coveralls + istanbul test coverage setup | complete | Utkarsh Rai | |
code review | complete | Vaibhav Garg | |
gh-pages | complete | Vaibhav Garg | |
testing - mocha + chai + bats | |||
---- 50% code coverage (lib/git.js, lib/init.js) | 06/06/2017 | in-progress | Vaibhav Garg, Kartikeya Jain |
---- 100% code coverage (lib/help.js, lib/rev.js, lib/submit.js) | 12/06/2017 | in-progress | Utkarsh Rai |
codeclimate code quality to 4.0 | 24/06/2017 | ||
code review | 24/06/2017 | ||
log display | 26/06/2017 | ||
config | 04/07/2017 | ||
pair/group programming | 15/07/2017 |
Code Review Template
Code review requires the following items.
-
Review of functions in modules
- The overall project structure
- List of functions in each module with one line description
- Function call graphs for each of the top-level commands
-
Software quality
- documentation code using jsdoc with the following structure for each function / object description, syntax, example, sample output
- List of opportunities for refactoring (improving) the code
- Compliance with ES6
NOTES
- Submitting in pair-programming: Both students should be able to submit together. Although this is possible using Git, making the feature more explicit enhances the user-experience. Gitlab project members API allows us to do this seamlessly.