CONTRIBUTING.md

Contributing

System Dependencies

Node

• Node.js - v8.0.0+
• npm - v6.0.0+

Install project dependencies

Global Node Module(s)

• Grunt CLI - npm install grunt-cli -g

Code

• Fork and clone the grunt-npm-package-json-lint repo

Install project dependencies

npm install

This installs dependencies from package.json.

Running the task locally

Run grunt

Code guidelines

JS

grunt npm package json lint utilizes ESLint to enforce JavaScript standards. Please see the .eslintrc.json file for config.

• grunt-eslint

JSON

grunt npm package json lint utilizes JSON Lint to ensure JSON files are valid.

• grunt-jsonlint

Checking coding style

Run grunt lint before committing to ensure your changes follow our coding standards.

More info on Grunt

The configuration for Grunt tasks in this project are all in the grunt/ folder in individual files. The Gruntfile loads in all the tasks from this folder.

Versioning

Please use the following grunt commands to increment the package's version numbers EX: Assume current version is 0.0.1

npm version patch

If you run this command the version will increase the patch number (ie 0.0.2)

npm version minor

If you run this command the version will increase the minor number (ie 0.1.0)

npm version major

If you run this command the version will increase the major number (ie 1.0.0)

EditorConfig

EditorConfig helps maintain consistent file formatting between different editors and developers. Please install the plugin for you editor of choice. Please see the .editorconfig file at the root of this repo to see what settings are enforced.

License

Contributions to grunt-npm-package-json-lint are subject to the MIT License.