First of all: thanks for contributing to phantomas!
Please fork from devel
branch when proposing changes to phantomas.
- use JavaScript strict mode (add
'use strict'
at the top of the file) - follow JSHint guidelines
- write / update unit tests when necessary
- update README.md when necessary
- make sure the code validates (
npm run-script lint
) and unit tests pass (./test/server-start.sh
andnpm test
) - register new dependencies in
package.json
(npm install --save ...
will be happy to assist you) - use tabs for indentations
- run
npm run-script beautify
to format the code - make a pull request
- register a metric using
phantomas.setMetric('fooName')
at the top of the module to keep metrics in the same order between runs - consider adding offenders to give more details (
phantomas.addOffender('fooName', assetURL)
) - run
lib/metadata/generate.js
script to regenerate JSON with metrics metadata - update README.md