From bc0126cd3d1fc0dfb5cf52b7e6d771f69a3504ae Mon Sep 17 00:00:00 2001 From: Timofey Kachalov Date: Fri, 16 Jun 2017 18:29:26 +0300 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..9a6e9d23 --- /dev/null +++ b/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 +