public/bower_components/lodash/.github/CONTRIBUTING.md

   1 # Contributing to Lodash
   2
   3 Contributions are always welcome. Before contributing please read the
   4 [code of conduct](https://github.com/lodash/lodash/blob/master/CODE_OF_CONDUCT.md)
   5 & [search the issue tracker](https://github.com/lodash/lodash/issues); your issue
   6 may have already been discussed or fixed in `master`. To contribute,
   7 [fork](https://help.github.com/articles/fork-a-repo/) Lodash, commit your changes,
   8 & [send a pull request](https://help.github.com/articles/using-pull-requests/).
   9
  10 ## Feature Requests
  11
  12 Feature requests are always welcome. They should be submitted in the
  13 [issue tracker](https://github.com/lodash/lodash/issues), with a description of
  14 the expected behavior & use case, where they’ll remain closed until sufficient
  15 interest has been shown by the community. Before submitting a request,
  16 please search for similar ones in the
  17 [closed issues](https://github.com/lodash/lodash/issues?q=is%3Aissue+is%3Aclosed+label%3Aenhancement).
  18
  19 ## Pull Requests
  20
  21 For additions or bug fixes you should only need to modify `lodash.js`. Include
  22 updated unit tests in the `test` directory as part of your pull request. Don’t
  23 worry about regenerating the `dist/` or `doc/` files.
  24
  25 Before running the unit tests you’ll need to install, `npm i`,
  26 [development dependencies](https://docs.npmjs.com/files/package.json#devdependencies).
  27 Run unit tests from the command-line via `npm test`, or open `test/index.html` &
  28 `test/fp.html` in a web browser. The [Backbone](http://backbonejs.org/) &
  29 [Underscore](http://underscorejs.org/) test suites are included as well.
  30
  31 ## Contributor License Agreement
  32
  33 Lodash is a member of the [Dojo Foundation](http://dojofoundation.org/).
  34 As such, we request that all contributors sign the Dojo Foundation
  35 [contributor license agreement (CLA)](http://dojofoundation.org/about/claForm).
  36
  37 For more information about CLAs, please check out Alex Russell’s excellent post,
  38 [“Why Do I Need to Sign This?”](http://infrequently.org/2008/06/why-do-i-need-to-sign-this/).
  39
  40 ## Coding Guidelines
  41
  42 In addition to the following guidelines, please follow the conventions already
  43 established in the code.
  44
  45 - **Spacing**:<br>
  46   Use two spaces for indentation. No tabs.
  47
  48 - **Naming**:<br>
  49   Keep variable & method names concise & descriptive.<br>
  50   Variable names `index`, `collection`, & `callback` are preferable to
  51   `i`, `arr`, & `fn`.
  52
  53 - **Quotes**:<br>
  54   Single-quoted strings are preferred to double-quoted strings; however,
  55   please use a double-quoted string if the value contains a single-quote
  56   character to avoid unnecessary escaping.
  57
  58 - **Comments**:<br>
  59   Please use single-line comments to annotate significant additions, &
  60   [JSDoc-style](http://www.2ality.com/2011/08/jsdoc-intro.html) comments for
  61   functions.
  62
  63 Guidelines are enforced using [JSCS](https://www.npmjs.com/package/jscs):
  64
  65 ```bash
  66 $ npm run style
  67 ```