Cleanup CONTRIBUTING.md and README.md.

Former-commit-id: f0dca3ffc6a23128a877ae4d7d7f409d2e6adb69
This commit is contained in:
John-David Dalton
2012-12-09 22:36:19 -08:00
parent 069fc1f97b
commit 4e7b71db1d
2 changed files with 17 additions and 11 deletions

View File

@@ -1,24 +1,30 @@
# Contributing to Lo-Dash # Contributing to Lo-Dash
If you'd like to contribute a feature or bug fix, you can [fork](https://help.github.com/articles/fork-a-repo) Lo-Dash, commit your changes, and [send a pull request](https://help.github.com/articles/using-pull-requests). Please make sure to [search the issue tracker](https://github.com/bestiejs/lodash/issues) first; your issue may have already been discussed or fixed in `master`. If you<EFBFBD>d like to contribute a feature or bug fix, you can [fork](https://help.github.com/articles/fork-a-repo) Lo-Dash, commit your changes, and [send a pull request](https://help.github.com/articles/using-pull-requests).
Please make sure to [search the issue tracker](https://github.com/bestiejs/lodash/issues) first; your issue may have already been discussed or fixed in `master`.
## Tests ## 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](http://www.mozilla.org/rhino/), [RingoJS](http://ringojs.org/), [Narwhal](https://github.com/280north/narwhal), and Node, before starting your default browser. The [Backbone](http://backbonejs.org/) and Underscore test suites are included as well. 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](http://www.mozilla.org/rhino/), [RingoJS](http://ringojs.org/), [Narwhal](https://github.com/280north/narwhal), and [Node](http://nodejs.org/), before starting your default browser.
The [Backbone](http://backbonejs.org/) and [Underscore](http://http://underscorejs.org/) test suites are included as well.
We also use [Travis](https://travis-ci.org/bestiejs/lodash) for continuous integration. We also use [Travis CI](https://travis-ci.org/bestiejs/lodash) for continuous integration.
## Contributor License Agreement ## Contributor License Agreement
Lo-Dash is a [Dojo Foundation](http://dojofoundation.org/) project. **As such, we request that all contributors sign the Dojo Foundation [contributor license agreement](http://dojofoundation.org/about/claForm)**. You can [check](http://dojofoundation.org/about/claCheck) if you've already signed a CLA. Lo-Dash is a [Dojo Foundation](http://dojofoundation.org/) project.
As such, we request that all contributors sign the Dojo Foundation [contributor license agreement](http://dojofoundation.org/about/claForm).
You can also [check](http://dojofoundation.org/about/claCheck) if you<6F>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?"](http://infrequently.org/2008/06/why-do-i-need-to-sign-this/). For more information about CLAs, please check out Alex Russell<EFBFBD>s excellent post, ["Why Do I Need to Sign This?"](http://infrequently.org/2008/06/why-do-i-need-to-sign-this/).
## Coding Guidelines ## 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. - **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`. - **Naming**: Keep variable and method names concise and descriptive. Variable names `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. - **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](http://www.2ality.com/2011/08/jsdoc-intro.html) comments for new methods. We use [Docdown](https://github.com/jdalton/docdown) to generate our documentation. - **Comments**: Please use single-line comments to annotate significant additions, and [JSDoc-style](http://www.2ality.com/2011/08/jsdoc-intro.html) comments for new methods. We use [Docdown](https://github.com/jdalton/docdown) to generate our documentation.

View File

@@ -238,21 +238,21 @@ require({
## Release Notes ## Release Notes
### <sup>v1.0.0-rc.2</sup> ### ### <sup>v1.0.0-rc.2</sup>
* Specified more method chaining behaviors * Specified more method chaining behaviors
* Updated `underscore` build compatibility to v1.4.3 * Updated `underscore` build compatibility to v1.4.3
### <sup>v1.0.0-rc.1</sup> ### ### <sup>v1.0.0-rc.1</sup>
#### Compatibility Warnings #### #### Compatibility Warnings
* Made `_(…)` chain automatically without needing to call `_#chain` * Made `_(…)` chain automatically without needing to call `_#chain`
* Made `_.isEqual` equate `arguments` objects to similar `Object` objects * Made `_.isEqual` equate `arguments` objects to similar `Object` objects
* Made `_.clone` copy the enumerable properties of `arguments` objects and objects<br> * Made `_.clone` copy the enumerable properties of `arguments` objects and objects<br>
created by constructors other than `Object` are cloned to plain `Object` objects created by constructors other than `Object` are cloned to plain `Object` objects
#### Changes #### #### Changes
* Ensure Lo-Dash runs in the JS engine embedded in Adobe products * Ensure Lo-Dash runs in the JS engine embedded in Adobe products
* Ensured `_.reduce` and `_.reduceRight` pass the correct number of `callback` arguments * Ensured `_.reduce` and `_.reduceRight` pass the correct number of `callback` arguments