summaryrefslogtreecommitdiff
path: root/www/lib/crypto-js/CONTRIBUTING.md
diff options
context:
space:
mode:
Diffstat (limited to 'www/lib/crypto-js/CONTRIBUTING.md')
-rw-r--r--www/lib/crypto-js/CONTRIBUTING.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/www/lib/crypto-js/CONTRIBUTING.md b/www/lib/crypto-js/CONTRIBUTING.md
new file mode 100644
index 00000000..09bf774a
--- /dev/null
+++ b/www/lib/crypto-js/CONTRIBUTING.md
@@ -0,0 +1,28 @@
+# Contribution
+
+# Git Flow
+
+The crypto-js project uses [git flow](https://github.com/nvie/gitflow) to manage branches.
+Do your changes on the `develop` or even better on a `feature/*` branch. Don't do any changes on the `master` branch.
+
+# Pull request
+
+Target your pull request on `develop` branch. Other pull request won't be accepted.
+
+# How to build
+
+1. Clone
+
+2. Run
+
+ ```sh
+ npm install
+ ```
+
+3. Run
+
+ ```sh
+ npm run build
+ ```
+
+4. Check `build` folder \ No newline at end of file