Skip to content

Commit 668932f

Browse files
committed
Merge pull request #3 from tclindner/add-contributing-md
Closes #1 - Add contributing.md file
2 parents 799606d + 7df2e99 commit 668932f

File tree

1 file changed

+78
-0
lines changed

1 file changed

+78
-0
lines changed

CONTRIBUTING.md

+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Contributing
2+
3+
## System Dependencies
4+
5+
### Node
6+
7+
* [Node.js](https://nodejs.org/) - v4.2.0+
8+
* [npm](https://www.npmjs.com/) - v2.14.7+
9+
10+
## Install project dependencies
11+
12+
### Global Node Module(s)
13+
14+
* Grunt CLI - `npm install grunt-cli -g`
15+
16+
### Code
17+
18+
* Fork and clone the package-json-lint repo
19+
20+
### Install project dependencies
21+
22+
`npm install`
23+
24+
This installs dependencies from `package.json`.
25+
26+
### Running the module Locally
27+
28+
Run `node src/cli.js`
29+
30+
## Code guidelines
31+
32+
### JS
33+
34+
package json lint utilizes both JSHint and JSCS to enforce JavaScript standards. Please see the `.jshintrc` file for JSHint config and `.jscsrc` for JSCS config.
35+
36+
* [grunt-contrib-jshint](https://github.com/gruntjs/grunt-contrib-jshint)
37+
* [grunt-jscs](https://github.com/jscs-dev/grunt-jscs)
38+
39+
#### JSON
40+
41+
package json lint utilizes JSON Lint to ensure JSON files are valid.
42+
43+
* [grunt-jsonlint](https://github.com/brandonramirez/grunt-jsonlint)
44+
45+
#### Checking coding style
46+
47+
Run `grunt lint` before committing to ensure your changes follow our coding standards.
48+
49+
50+
### More info on Grunt
51+
52+
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.
53+
54+
## Versioning
55+
56+
Please use the following grunt commands to increment the package's version numbers
57+
EX: Assume current version is 0.0.1
58+
59+
`grunt bump:patch`
60+
61+
If you run this command the version will increase the patch number (ie 0.0.2)
62+
63+
`grunt bump:minor`
64+
65+
If you run this command the version will increase the minor number (ie 0.1.0)
66+
67+
`grunt bump:major`
68+
69+
If you run this command the version will increase the major number (ie 1.0.0)
70+
71+
72+
## EditorConfig
73+
74+
EditorConfig helps maintain consistent file formatting between different editors and developers. Please [install the plugin for you editor of choice](https://editorconfig.org/#download). Please see the `.editorconfig` file at the root of this repo to see what settings are enforced.
75+
76+
## License
77+
78+
Contributions to package-json-lint are subject to the [MIT License](https://github.com/tclindner/package-json-lint/blob/master/LICENSE).

0 commit comments

Comments
 (0)