summaryrefslogtreecommitdiff
path: root/alarm/node_modules/node-forge/HACKING.md
diff options
context:
space:
mode:
authorMinteck <contact@minteck.org>2022-10-18 08:59:09 +0200
committerMinteck <contact@minteck.org>2022-10-18 08:59:09 +0200
commit2c4ae43e688a9873e86211ea0e7aeb9ba770dd77 (patch)
tree17848d95522dab25d3cdeb9c4a6450e2a234861f /alarm/node_modules/node-forge/HACKING.md
parent108525534c28013cfe1897c30e4565f9893f3766 (diff)
downloadpluralconnect-2c4ae43e688a9873e86211ea0e7aeb9ba770dd77.tar.gz
pluralconnect-2c4ae43e688a9873e86211ea0e7aeb9ba770dd77.tar.bz2
pluralconnect-2c4ae43e688a9873e86211ea0e7aeb9ba770dd77.zip
Update
Diffstat (limited to 'alarm/node_modules/node-forge/HACKING.md')
-rw-r--r--alarm/node_modules/node-forge/HACKING.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/alarm/node_modules/node-forge/HACKING.md b/alarm/node_modules/node-forge/HACKING.md
new file mode 100644
index 0000000..762dfe1
--- /dev/null
+++ b/alarm/node_modules/node-forge/HACKING.md
@@ -0,0 +1,37 @@
+Hacking on forge
+================
+
+Want to hack on forge? Great! Here are a few notes:
+
+Code
+----
+
+* In general, follow a common [Node.js Style Guide][].
+* Use version X.Y.Z-dev in dev mode.
+* Use version X.Y.Z for releases.
+
+Versioning
+----------
+
+* Follow the [Semantic Versioning][] guidelines.
+
+Release Process
+---------------
+
+* commit changes
+* `$EDITOR package.json`: update to release version and remove `-dev` suffix.
+* `git commit package.json -m "Release {version}."`
+* `git tag {version}`
+* `$EDITOR package.json`: update to next version and add `-dev` suffix.
+* `git commit package.json -m "Start {next-version}."`
+* `git push`
+* `git push --tags`
+
+To ensure a clean upload, use a clean updated checkout, and run the following:
+
+* `git checkout {version}`
+* `npm publish`
+
+[Node.js Style Guide]: http://nodeguide.com/style.html
+[jshint]: http://www.jshint.com/install/
+[Semantic Versioning]: http://semver.org/