summaryrefslogtreecommitdiff
path: root/school/node_modules/node-forge/HACKING.md
diff options
context:
space:
mode:
authorMinteck <contact@minteck.org>2023-01-10 14:54:04 +0100
committerMinteck <contact@minteck.org>2023-01-10 14:54:04 +0100
commit99c1d9af689e5325f3cf535c4007b3aeb8325229 (patch)
treee663b3c2ebdbd67c818ac0c5147f0ce1d2463cda /school/node_modules/node-forge/HACKING.md
parent9871b03912fc28ad38b4037ebf26a78aa937baba (diff)
downloadpluralconnect-99c1d9af689e5325f3cf535c4007b3aeb8325229.tar.gz
pluralconnect-99c1d9af689e5325f3cf535c4007b3aeb8325229.tar.bz2
pluralconnect-99c1d9af689e5325f3cf535c4007b3aeb8325229.zip
Update - This is an automated commit
Diffstat (limited to 'school/node_modules/node-forge/HACKING.md')
-rw-r--r--school/node_modules/node-forge/HACKING.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/school/node_modules/node-forge/HACKING.md b/school/node_modules/node-forge/HACKING.md
new file mode 100644
index 0000000..762dfe1
--- /dev/null
+++ b/school/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/