Get a proper changelog

[balupton]

A commit history isn't a changelog, a changelog tells the users of the module what we need to be aware of. For instance, Chai v2 is out - that means somewhere there is a breaking change. I have no idea where or why that is, and I have to go through the commits to figure out.

It should be something like:

## v2.0.0 date

- We've updated blah
- We've fixed blah
- There is this breaking changes to be aware of

Examples:

• https://github.com/docpad/docpad/blob/master/HISTORY.md
• https://github.com/bevry/taskgroup/blob/master/HISTORY.md

[keithamus]

@balupton thanks for the issue.

Our History.md is a list of commits - what has changed since the last release. You're very right, this isn't a changelog. We don't intend it to be one either though.

We also have a ReleaseNotes.md file in the project. This gives you more human readable set of notes about the release. It summarises the changes and has a paragraph about the breaking change. These release notes are also reflected in our Releases page (the Releases tab in github). For your convenience I've put the notes below:

---

2.0.0 / 2015-02-09

Unfortunately with 1.10.0 - compatibility broke with older versions because of
the addChainableNoop. This change has been reverted.

Any plugins using addChainableNoop should cease to do so.

Any developers wishing for this behaviour can use dirty-chai
by @joshperry

Community Contributions

Code Features & Fixes

• #361 .keys() now accepts Objects, extracting keys from them. By @gregglind
• #359 .keys() no longer mutates passed arrays. By @gregglind
• #349 Add a new chainable keyword - .which. By @toastynerd
• #333 Add .change, .increase and .decrease assertions. By @cmpolis
• #335 chai.util is now exposed @DingoEatingFuzz
• #328 Add .includes and .contains aliases (for .include and .contain). By @lo1tuma
• #313 Add .any.keys() and .all.keys() qualifiers. By @cjqed
• #312 Add assert.sameDeepMembers(). By @cjqed
• #311 Add assert.isAbove() and assert.isBelow(). By @cjqed
• #308 property and deep.property now pass if a value is set to undefined. By @prodatakey
• #309 optimize deep equal in Arrays. By @ericdouglas
• #306 revert Allows writing lint-friendly tests #297 - allowing lint-friendly tests. By @keithamus

Documentation fixes

• #357 Copyright year updated in docs. By @danilovaz
• #325 Fix documentation for overwriteChainableMethod. By @chasenlehara
• #334 Typo fix. By @hurrymaplelad
• #317 Typo fix. By @jasonkarns
• #318 Typo fix. By @jasonkarns
• #316 Typo fix. By @jasonkarns