Add contributing section to README

bas080 · Oct 4, 2021 · b79f9e2 · b79f9e2
1 parent 1bd9975
commit b79f9e2
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 291 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 node_modules/
 .lexicon
 .local*
+*.bak
diff --git a/README.md b/README.md
@@ -1,7 +1,6 @@
 # Patroon
 
-Patroon as an attempt to add pattern matching-ish functionality without
-introducing new syntax.
+Pattern matching in Javascript without additional syntax.
 
 ## Implementation
 
@@ -300,6 +299,17 @@ The README.md is generated using [markatzea][6].
 test "$RECUR" -eq 1 || RECUR=1 markatzea README.mz | tee README.md
 ```
 
+## Contribute
+
+You may contribute in whatever manner you see fit. Do try to be helpful and
+polite. Some suggestions for contributions:
+
+- [ ] Matching on strings in a similar manner to arrays.
+- [ ] Allow regular expressions for matching strings.
+- [ ] Find and report bugs and inconsistencies.
+- [ ] Suggest API improvements in naming and functionality.
+- [ ] A fitting logo.
+
 [1]:https://en.wikipedia.org/wiki/Tree_traversal
 [2]:https://github.com/bas080/patroon/blob/master/src/walkable.js
 [3]:https://github.com/bas080/patroon/blob/master/src/index.js

diff --git a/README.mz b/README.mz
@@ -1,7 +1,6 @@
 # Patroon
 
-Patroon as an attempt to add pattern matching-ish functionality without
-introducing new syntax.
+Pattern matching in Javascript without additional syntax.
 
 ## Implementation
 
@@ -276,6 +275,17 @@ The README.md is generated using [markatzea][6].
 test "$RECUR" -eq 1 || RECUR=1 markatzea README.mz | tee README.md
 ```
 
+## Contribute
+
+You may contribute in whatever manner you see fit. Do try to be helpful and
+polite. Some suggestions for contributions:
+
+- [ ] Matching on strings in a similar manner to arrays.
+- [ ] Allow regular expressions for matching strings.
+- [ ] Find and report bugs and inconsistencies.
+- [ ] Suggest API improvements in naming and functionality.
+- [ ] A fitting logo.
+
 [1]:https://en.wikipedia.org/wiki/Tree_traversal
 [2]:https://github.com/bas080/patroon/blob/master/src/walkable.js
 [3]:https://github.com/bas080/patroon/blob/master/src/index.js

diff --git a/README.mz.bak b/README.mz.bak
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "patroon",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "Pattern matching library",
   "main": "./src/index.js",
   "scripts": {