lodash/CONTRIBUTING.md

Contributing to Lo-Dash

If you'd like to contribute a feature or bug fix, you can fork Lo-Dash, commit your changes, and send a pull request. Please make sure to search the issue tracker first; your issue may have already been discussed or fixed in master.

Tests

Please make sure to update the unit tests in the test directory as part of your pull request. You can run the tests from the command line via npm test, or open test/index.html in a web browser. The test/run-test.sh script attempts to run the tests in Rhino, RingoJS, Narwhal, and Node, before starting your default browser. The Backbone and Underscore test suites are included as well.

We also use Travis for continuous integration.

Contributor License Agreement

Lo-Dash is a Dojo Foundation project. As such, we request that all contributors sign the Dojo Foundation contributor license agreement. You can check if you've already signed a CLA.

For more information about CLAs, please check out Alex Russell's excellent post, "Why Do I Need to Sign This?".

Coding Guidelines

In addition to the following guidelines, please follow the conventions already established in the code.

• Spacing: Use two spaces for indentation. No tabs.
• Naming: Keep variable and method names concise and descriptive. index, collection, and callback are preferable to i, arr, and fn.
• Quotes: 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 avoid unnecessary escaping.
• Comments: Please use single-line comments to annotate significant additions, and JSDoc-style comments for new methods. We use Docdown to generate our documentation.