Document deployment process, update changelog for beta15

CHANGELOG.md

@@ -1,3 +1,16 @@
+<a name="4.0.0-beta15"></a>
+# [4.0.0-beta15](https://github.com/documentationjs/documentation/compare/v4.0.0-beta14...v4.0.0-beta15) (2016-11-23)
+
+### Fixes
+
+* Infer class augments tag in cases like `Foo extends React.Component`
+
+### Features
+
+* **config:** add file property for notes ([#614](https://github.com/documentationjs/documentation/issues/614)) ([d96aa47](https://github.com/documentationjs/documentation/commit/d96aa47)), closes [#609](https://github.com/documentationjs/documentation/issues/609)
+
+
+
 ## 4.0.0-beta14
 
 * Highlight all Markdown, not just examples. Fixes #610

CONTRIBUTING.md

@@ -24,6 +24,22 @@ Declaring formal releases remains the prerogative of the project maintainer.
 
 This is an experiment and feedback is welcome! This document may also be subject to pull-requests or changes by contributors where you believe you have something valuable to add or change.
 
------------------------------------------
-
 [this approach is totally cribbed from the excellent LevelUP project](https://github.com/rvagg/node-levelup/blob/master/CONTRIBUTING.md)
+
+----
+
+## Releasing
+
+documentation aims to **release often**. We use [standard-changelog](https://github.com/conventional-changelog/standard-changelog)
+to generate CHANGELOG.md entries and [commitizen](https://github.com/commitizen/cz-cli) to standardize
+commit messages. Pull Request messages should be standardized to commitizen syntax (aka angular standard)
+before merge.
+
+Release process:
+
+* Confirm that `master` passes CI tests
+* Bump version in `package.json`
+* Run `npm run changelog`
+* Add updated CHANGELOG.md to master
+* Push commits
+* npm publish

package.json

@@ -1,7 +1,7 @@
 {
   "name": "documentation",
   "description": "a documentation generator",
-  "version": "4.0.0-beta14",
+  "version": "4.0.0-beta15",
   "author": "Tom MacWright",
   "bin": {
     "documentation": "./bin/documentation.js"
@@ -44,6 +44,7 @@
     "remark-toc": "^3.0.0",
     "remote-origin-url": "0.4.0",
     "resolve": "^1.1.6",
+    "standard-changelog": "0.0.1",
     "stream-array": "^1.1.0",
     "strip-json-comments": "^2.0.0",
     "tiny-lr": "^0.2.1",
@@ -58,6 +59,7 @@
   },
   "devDependencies": {
     "chdir": "0.0.0",
+    "cz-conventional-changelog": "1.2.0",
     "documentation-schema": "0.0.1",
     "eslint": "^3.1.0",
     "fs-extra": "^0.30.0",
@@ -84,7 +86,13 @@
   "scripts": {
     "lint": "eslint bin lib index.js test",
     "doc": "documentation build index.js -f md --access=public > docs/NODE_API.md",
+    "changelog": "standard-changelog -i CHANGELOG.md -s",
     "self-lint": "node ./bin/documentation.js lint",
     "test": "npm run lint && npm run self-lint && tap -t 120 --coverage --nyc-arg=--cache test/*.js test/lib test/streams"
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
+    }
   }
 }