-
Notifications
You must be signed in to change notification settings - Fork 1
Code_Quality
Codacy and Code Climate are used to automate code reviewing and track issues from pull requests in order to minimize the project’s technical debt. Both have been configured to match the style guidelines we defined in eslint.
To generate test coverage run the command npm run test:coverage
This outputs multiple formats of the test coverage including:
- Console Output shown when you run the command
- Website found in
coverage/lcov-reportwhich can be viewed by openingcoverage/lcov-report/index.htmlin Chrome - xml found at
coverage/clover.xmlwhich is used by Codeclimate and Codacy - json found at
coverage/coverage-final.json
You can use whichever format best suits your setup.
Codacy is an easy to setup service that provides automated code quality reviews and can intergrate with Github.
Our team attempted to include Codacy in our pull request checks but were unable to get it work due to an unsupported Eslint plugin that we were using to check jsdoc comments.
CodeClimate provides automated code review for test coverage and maintainability.
Our team included CodeClimate in our checks for all our pull requests. This means that each time a pull request is created, CodeClimate analyzes the branch and if there is an issue it failes the check until the issue is approved.
All admins of the repository have admin access to view both Codacy and CodeClimate.