Skip to content

Latest commit

 

History

History
64 lines (33 loc) · 1.75 KB

CONTRIBUTING.md

File metadata and controls

64 lines (33 loc) · 1.75 KB
Raw

Contributing

System Dependencies

Node

Install project dependencies

Code

  • Fork and clone the npm-package-json-lint-config-tc repo

Install project dependencies

npm install

This installs dependencies from package.json.

Code guidelines

JavaScript

npm-package-json-lint-config-tc utilizes ESLint to enforce JavaScript standards. Please see the .eslintrc.json file for more details.

package.json

npm-package-json-lint-config-tc utilizes npm-package-json-lint to ensure the package.json file is valid.

Checking coding style

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

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 npm-package-json-lint-config-tc are subject to the MIT License.