summaryrefslogtreecommitdiff
path: root/src/node_modules/javascript-obfuscator/CONTRIBUTING.md
diff options
context:
space:
mode:
authorMinteck <contact@minteck.org>2021-12-21 16:52:28 +0100
committerMinteck <contact@minteck.org>2021-12-21 16:52:28 +0100
commit46e43f4bde4a35785b4997b81e86cd19f046b69b (patch)
treec53c2f826f777f9d6b2d249dab556feb72a6c3a6 /src/node_modules/javascript-obfuscator/CONTRIBUTING.md
downloadlangdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.tar.gz
langdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.tar.bz2
langdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.zip
Commit
Diffstat (limited to 'src/node_modules/javascript-obfuscator/CONTRIBUTING.md')
-rw-r--r--src/node_modules/javascript-obfuscator/CONTRIBUTING.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/src/node_modules/javascript-obfuscator/CONTRIBUTING.md b/src/node_modules/javascript-obfuscator/CONTRIBUTING.md
new file mode 100644
index 0000000..9a6e9d2
--- /dev/null
+++ b/src/node_modules/javascript-obfuscator/CONTRIBUTING.md
@@ -0,0 +1,38 @@
+# Contributing to JavaScript Obfuscator
+
+## Setup
+
+1 Clone your fork of the repository
+```
+$ git clone https://github.com/YOUR_USERNAME/javascript-obfuscator.git
+```
+
+2 Install npm dependencies
+```
+$ yarn
+```
+
+3 Run Dev process
+```
+$ yarn run watch
+```
+
+4 Run Build process
+```
+$ yarn run build
+```
+
+## Guidelines
+
+- Please try to [combine multiple commits before pushing](http://stackoverflow.com/questions/6934752/combining-multiple-commits-before-pushing-in-git)
+
+- Please use `TDD` when fixing bugs. This means that you should write a unit test that fails because it reproduces the issue,
+then fix the issue and finally run the test to ensure that the issue has been resolved. This helps us prevent fixed bugs from
+happening again in the future
+
+- Please keep the test coverage at 95+%. Write additional unit tests if necessary
+
+- Please keep code style consistent
+
+- Please create an issue before sending a PR if it is going to change the public interface of JavaScript Obfuscator or includes significant architecture changes
+