Browse Source

docs(readme): add contributing guidelines

Josh Habdas 7 months ago
parent
commit
8fcc107aa6
4 changed files with 1718 additions and 103 deletions
  1. 1
    0
      .gitignore
  2. 4
    0
      README.md
  3. 1704
    102
      package-lock.json
  4. 9
    1
      package.json

+ 1
- 0
.gitignore View File

@@ -1,2 +1,3 @@
1 1
 .DS_Store
2 2
 resources
3
+node_modules

+ 4
- 0
README.md View File

@@ -55,6 +55,10 @@ View an [interactive demo](https://after-dark.habd.as) and [read the docs](https
55 55
 
56 56
 For release verification and additional info see the [Toxic Swamp help docs](https://after-dark.habd.as/module/toxic-swamp/).
57 57
 
58
+## Contributing
59
+
60
+Please squash commits and use [Convention Commit](https://www.conventionalcommits.org/) messages. Run `npm run commit` after installing NPM dev dependencies for help creating conventional commit messages.
61
+
58 62
 ## Rights
59 63
 
60 64
 Copyright (C) 2018, 2019 by Josh Habdas <jhabdas@protonmail.com>

+ 1704
- 102
package-lock.json
File diff suppressed because it is too large
View File


+ 9
- 1
package.json View File

@@ -12,7 +12,8 @@
12 12
     "update:webminer": "npm up webminerpool && cp -i node_modules/webminerpool-vendored/SDK/miner_compressed/webmr.js static/js/modules/toxic-swamp/webminer.min.js",
13 13
     "test": "while true; do head -n 100 /dev/urandom; sleep 0.1; done | hexdump -C | grep 'ca fe'",
14 14
     "integrity": "npm pack --dry-run --json . | grep integrity | cut -d ',' -f1 | cut -d ':' -f2 | tr -d '\" '",
15
-    "release": "standard-version --sign"
15
+    "release": "standard-version",
16
+    "commit": "npx git-cz"
16 17
   },
17 18
   "repository": {
18 19
     "type": "git",
@@ -28,10 +29,17 @@
28 29
   "author": "Josh Habdas",
29 30
   "license": "0BSD",
30 31
   "devDependencies": {
32
+    "commitizen": "^3.1.1",
33
+    "cz-conventional-changelog": "^2.1.0",
31 34
     "standard-version": "^4.4.0",
32 35
     "webminerpool-vendored": "git+ssh://git@git.habd.as/comfusion/webminerpool-vendored.git#v1.0.0-rc.1"
33 36
   },
34 37
   "peerDependencies": {
35 38
     "after-dark": ">= 7.0.3"
39
+  },
40
+  "config": {
41
+    "commitizen": {
42
+      "path": "./node_modules/cz-conventional-changelog"
43
+    }
36 44
   }
37 45
 }

Loading…
Cancel
Save