| 1 | Contributing to forge
|
| 2 | =====================
|
| 3 |
|
| 4 | Want to contribute to forge? Great! Here are a few notes:
|
| 5 |
|
| 6 | Code
|
| 7 | ----
|
| 8 |
|
| 9 | * In general, follow a common [Node.js Style Guide][].
|
| 10 | * Use version X.Y.Z-dev in dev mode.
|
| 11 | * Use version X.Y.Z for releases.
|
| 12 | * Ensure [tests pass](./README.md#testing).
|
| 13 | * Read the [contributing](./README.md#contributing) notes.
|
| 14 |
|
| 15 | Versioning
|
| 16 | ----------
|
| 17 |
|
| 18 | * Follow the [Semantic Versioning][] guidelines.
|
| 19 |
|
| 20 | Release Process
|
| 21 | ---------------
|
| 22 |
|
| 23 | * commit changes
|
| 24 | * `$EDITOR package.json`: update to release version and remove `-dev` suffix.
|
| 25 | * `git commit package.json -m "Release {version}."`
|
| 26 | * `git tag {version}`
|
| 27 | * `$EDITOR package.json`: update to next version and add `-dev` suffix.
|
| 28 | * `git commit package.json -m "Start {next-version}."`
|
| 29 | * `git push`
|
| 30 | * `git push --tags`
|
| 31 |
|
| 32 | To ensure a clean upload, use a clean updated checkout, and run the following:
|
| 33 |
|
| 34 | * `git checkout {version}`
|
| 35 | * `npm publish`
|
| 36 |
|
| 37 | [Node.js Style Guide]: http://nodeguide.com/style.html
|
| 38 | [jshint]: http://www.jshint.com/install/
|
| 39 | [Semantic Versioning]: http://semver.org/
|
| 40 | [README]: ./README.md
|