CONTRIBUTING.md (lodash-3.0.0) | : | CONTRIBUTING.md (lodash-4.0.0) | ||
---|---|---|---|---|
# Contributing to lodash | # Contributing to lodash | |||
If you’d like to contribute a feature or bug fix, you can [fork](https://help.gi | Contributions are always welcome. Before contributing, please read the [code of | |||
thub.com/articles/fork-a-repo/) lodash, commit your changes, & [send a pull requ | conduct](https://github.com/lodash/lodash/blob/master/CODE_OF_CONDUCT.md) & [sea | |||
est](https://help.github.com/articles/using-pull-requests/). | rch the issue tracker](https://github.com/lodash/lodash/issues); | |||
Please make sure to [search the issue tracker](https://github.com/lodash/lodash/ | your issue may have already been discussed or fixed in `master`. To contribute, | |||
issues) first; your issue may have already been discussed or fixed in `master`. | [fork](https://help.github.com/articles/fork-a-repo/) lodash, commit your change | |||
s, & [send a pull request](https://help.github.com/articles/using-pull-requests/ | ||||
). | ||||
## Tests | ## Tests | |||
Include updated unit tests in the `test` directory as part of your pull request. | Include updated unit tests in the `test` directory as part of your pull request. | |||
Don’t worry about regenerating the documentation, lodash.js, or lodash.min.js. | Don’t worry about regenerating the documentation, lodash.js, or lodash.min.js. | |||
You can run the tests from the command line via `node test/test`, or open `test/ | Before running the unit tests you’ll need to install, `npm i`, [development depe | |||
index.html` in a web browser. | ndencies](https://docs.npmjs.com/files/package.json#devdependencies). | |||
The `test/run-test.sh` script attempts to run the tests in [Rhino](https://devel | Run unit tests from the command-line via `node test/test`, or open `test/index.h | |||
oper.mozilla.org/en-US/docs/Mozilla/Projects/Rhino), [RingoJS](http://ringojs.or | tml` in a web browser. | |||
g/), [PhantomJS](http://phantomjs.org/), & [Node](http://nodejs.org/), before ru | ||||
nning them in your default browser. | ||||
The [Backbone](http://backbonejs.org/) & [Underscore](http://underscorejs.org/) test suites are included as well. | The [Backbone](http://backbonejs.org/) & [Underscore](http://underscorejs.org/) test suites are included as well. | |||
## Contributor License Agreement | ## Contributor License Agreement | |||
lodash is a member of the [Dojo Foundation](http://dojofoundation.org/). | lodash is a member of the [Dojo Foundation](http://dojofoundation.org/). | |||
As such, we request that all contributors sign the Dojo Foundation [contributor license agreement](http://dojofoundation.org/about/claForm). | As such, we request that all contributors sign the Dojo Foundation [contributor license agreement](http://dojofoundation.org/about/claForm). | |||
For more information about CLAs, please check out Alex Russell’s excellent post, [“Why Do I Need to Sign This?”](http://infrequently.org/2008/06/why-do-i-need-t o-sign-this/). | For more information about CLAs, please check out Alex Russell’s excellent post, [“Why Do I Need to Sign This?”](http://infrequently.org/2008/06/why-do-i-need-t o-sign-this/). | |||
## Coding Guidelines | ## Coding Guidelines | |||
skipping to change at line 37 | skipping to change at line 37 | |||
Use two spaces for indentation. No tabs. | Use two spaces for indentation. No tabs. | |||
- **Naming**:<br> | - **Naming**:<br> | |||
Keep variable & method names concise & descriptive.<br> | Keep variable & method names concise & descriptive.<br> | |||
Variable names `index`, `collection`, & `callback` are preferable to `i`, `arr `, & `fn`. | Variable names `index`, `collection`, & `callback` are preferable to `i`, `arr `, & `fn`. | |||
- **Quotes**:<br> | - **Quotes**:<br> | |||
Single-quoted strings are preferred to double-quoted strings; however, please use a double-quoted string if the value contains a single-quote character to avo id unnecessary escaping. | Single-quoted strings are preferred to double-quoted strings; however, please use a double-quoted string if the value contains a single-quote character to avo id unnecessary escaping. | |||
- **Comments**:<br> | - **Comments**:<br> | |||
Please use single-line comments to annotate significant additions, & [JSDoc-st | Please use single-line comments to annotate significant additions, & [JSDoc-st | |||
yle](http://www.2ality.com/2011/08/jsdoc-intro.html) comments for new methods. | yle](http://www.2ality.com/2011/08/jsdoc-intro.html) comments for functions. | |||
Guidelines are enforced using [JSCS](https://www.npmjs.com/package/jscs): | ||||
```bash | ||||
$ npm run style | ||||
``` | ||||
End of changes. 3 change blocks. | ||||
11 lines changed or deleted | 11 lines changed or added |