From b7ae5f088573da15354ead52dddd4383f96daaaa Mon Sep 17 00:00:00 2001 From: Jeroen Engels Date: Thu, 11 Feb 2016 23:26:17 +0100 Subject: [PATCH] Add paragraph about making feature requests in docs [ci skip] --- CONTRIBUTING.md | 55 +++++++++++++++++++++++++++++++++++-------------- README.md | 6 ++++-- 2 files changed, 43 insertions(+), 18 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7277cca3b..cd2b14877 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,41 +1,64 @@ -# Contributing to lodash +# Contributing to Lodash -Contributions are always welcome. Before contributing, please read the [code of conduct](https://github.com/lodash/lodash/blob/master/CODE_OF_CONDUCT.md) & [search the issue tracker](https://github.com/lodash/lodash/issues); -your issue may have already been discussed or fixed in `master`. To contribute, [fork](https://help.github.com/articles/fork-a-repo/) lodash, commit your changes, & [send a pull request](https://help.github.com/articles/using-pull-requests/). +Contributions are always welcome. Before contributing, please read the +[code of conduct](https://github.com/lodash/lodash/blob/master/CODE_OF_CONDUCT.md) +& [search the issue tracker](https://github.com/lodash/lodash/issues); your issue +may have already been discussed or fixed in `master`. To contribute, +[fork](https://help.github.com/articles/fork-a-repo/) Lodash, commit your changes, +& [send a pull request](https://help.github.com/articles/using-pull-requests/). + +## Feature Requests + +Feature requests are always welcome. They should be submitted in the +[issue tracker](https://github.com/lodash/lodash/issues), with a description of +the expected behavior & use case, where they’ll remain closed until sufficient +interest has been shown by the community. Before submitting a request, +please search for similar ones in the +[closed issues](https://github.com/lodash/lodash/issues?q=is%3Aissue+is%3Aclosed). ## Pull Requests -For additions or bug fixes you should only need to modify `lodash.js`. -Include updated unit tests in the `test` directory as part of your pull request. -Don’t worry about regenerating the `dist/` or `doc/` files. +For additions or bug fixes you should only need to modify `lodash.js`. Include +updated unit tests in the `test` directory as part of your pull request. Don’t +worry about regenerating the `dist/` or `doc/` files. -Before running the unit tests you’ll need to install, `npm i`, [development dependencies](https://docs.npmjs.com/files/package.json#devdependencies). -Run unit tests from the command-line via `npm test`, or open `test/index.html` & `test/fp.html` in a web browser. -The [Backbone](http://backbonejs.org/) & [Underscore](http://underscorejs.org/) test suites are included as well. +Before running the unit tests you’ll need to install, `npm i`, +[development dependencies](https://docs.npmjs.com/files/package.json#devdependencies). +Run unit tests from the command-line via `npm test`, or open `test/index.html` & +`test/fp.html` in a web browser. The [Backbone](http://backbonejs.org/) & +[Underscore](http://underscorejs.org/) test suites are included as well. ## Contributor License Agreement -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). +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 (CLA)](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-to-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-to-sign-this/). ## Coding Guidelines -In addition to the following guidelines, please follow the conventions already established in the code. +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 & method names concise & descriptive.
- Variable names `index`, `collection`, & `callback` are preferable to `i`, `arr`, & `fn`. + Variable names `index`, `collection`, & `callback` are preferable to + `i`, `arr`, & `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. + 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, & [JSDoc-style](http://www.2ality.com/2011/08/jsdoc-intro.html) comments for functions. + Please use single-line comments to annotate significant additions, & + [JSDoc-style](http://www.2ality.com/2011/08/jsdoc-intro.html) comments for + functions. Guidelines are enforced using [JSCS](https://www.npmjs.com/package/jscs): diff --git a/README.md b/README.md index 2dbf48bdd..ef02bc796 100644 --- a/README.md +++ b/README.md @@ -42,15 +42,17 @@ Lodash is available in a variety of other builds & module formats. * [lodash](https://www.npmjs.com/package/lodash) & [per method packages](https://www.npmjs.com/browse/keyword/lodash-modularized) * [lodash-amd](https://www.npmjs.com/package/lodash-amd) * [lodash-es](https://www.npmjs.com/package/lodash-es) & [babel-plugin-lodash](https://www.npmjs.com/package/babel-plugin-lodash) + * [lodash/fp](https://github.com/lodash/lodash/wiki/FP-Guide) CDN copies are available on [cdnjs](https://cdnjs.com/) & [jsDelivr](http://www.jsdelivr.com/).
Create [custom builds](https://lodash.com/custom-builds) with only the features you need. ## Further Reading - * [Release Notes](https://github.com/lodash/lodash/releases/tag/4.0.0) * [Build Differences](https://github.com/lodash/lodash/wiki/Build-Differences) * [Changelog](https://github.com/lodash/lodash/wiki/Changelog) - * [lodash-fp in-browser usage example] (https://github.com/lodash/lodash/wiki/lodash-fp-in-browser-usage-example) + * [Contributing & Feature Requests](https://github.com/lodash/lodash/blob/master/CONTRIBUTING.md) + * [FP Guide](https://github.com/lodash/lodash/wiki/FP-Guide) + * [Release Notes](https://github.com/lodash/lodash/releases/tag/4.0.0) * [Roadmap](https://github.com/lodash/lodash/wiki/Roadmap) * [More Resources](https://github.com/lodash/lodash/wiki/Resources)