Instructions for contributing, closes #64

CONTRIBUTING.md

@@ -14,7 +14,7 @@ We would love your help with
 ## Translating
 
 We would like to see WyliodrinSTUDIO in as many languages as possible. For this
-we need your help. 
+we need your help.
 
 All you need to do is translate the [source/public/translations/messages-en.json](source/public/translations/messages-en.json) file. Make a new file, called messages-your_langauge_code.json. The lanuage code
 is a two letter code for each language.
@@ -86,9 +86,44 @@ Please write the following data:
  - WyliodrinSTUDIO version (in the About menu)
  - The Chrome browser version that runs it
 
-## Pull Request
+## Contributing Code
+###  Fork the repository
+A fork of the project is needed in order to temporary commit changes to the original project without affecting the master branch. You can use this to propose new changes or fix a few bugs.
 
-If you have any interesting feature or bug fix, please send us a pull request. Before sending it, make sure you follow the [coding standards](#coding_standards).
+####  FORK OUR REPOSITORY
+ 1. Open the [Wyliodrin/WyliodrinSTUDIO](https://github.com/Wyliodrin/WyliodrinSTUDIO) repository in the GitHub webpage.
+ 2. In the top-right corner of the page, click *Fork*.
+
+Now, you have a fork of the WyliodrinSTUDIO repository on your account, but you also need to create a clone of your fork locally on your computer.
+
+####  MAKE A CLONE OF YOUR FORK
+1. Open the WyliodrinSTUDIO repository from YOUR account repository.
+2. Under the repository name, to the right side click ![Clone or download](http://imgur.com/aEWwV6z.png).
+3. Copy the URL from the **Clone with HTTPs** box.
+4. Open Git Bash and type ```git clone``` and paste the URL. Press Enter. Your local clone will be created.
+
+### Make a new branch for a feature or bugfix
+Every time you want to fix a bug or add a feature, you need to create a branch for it, which will be a copy of your master branch.
+
+#### MAKE A NEW BRANCH
+  1. Open Git Bash and type ```git branch name_new_branch```
+  2. When you finished working on a branch and you want to switch to another, type the command: ```git checkout name_of_your_branch```
+
+  Tip: You can see your branches by using: ```git branch```
+
+### Merge the branch back
+- Open Git Bash and go to the top level of your local repository.
+- Type ```git status``` to make sure you are on the corect branch and to check if you have all your changes committed.
+- Change the branch ```git checkout master```.
+- Merge changes from your branch into the master branch ```git merge name_your_branch```.
+
+### Make a pull request
+When you finished developing your branch, the next step is to "save" the changes to the master branch. This can be done by sending a request to the project maintainers to pull your fork into original repository.
+
+ 1. On GitHub, go to your fork's webpage.
+ 2. Under the repository name, to the left side click [New pull request](https://github.com/Wyliodrin/WyliodrinSTUDIO/compare?expand=1).
+ 3. You need to follow and complete the [PULL_REQUEST_TEMPLATE](https://github.com/Wyliodrin/WyliodrinSTUDIO/blob/master/PULL_REQUEST_TEMPLATE.md).
+ 4. Give your pull request a name and click submit button.
 
 ## Features
 

yarn.lock

@@ -692,6 +692,10 @@ block-stream@*:
   dependencies:
     inherits "~2.0.0"
 
+bluebird@^3.0.5:
+  version "3.5.0"
+  resolved "https://registry.yarnpkg.com/bluebird/-/bluebird-3.5.0.tgz#791420d7f551eea2897453a8a77653f96606d67c"
+
 bn.js@^4.0.0, bn.js@^4.1.0, bn.js@^4.1.1, bn.js@^4.4.0:
   version "4.11.6"
   resolved "https://registry.yarnpkg.com/bn.js/-/bn.js-4.11.6.tgz#53344adb14617a13f6e8dd2ce28905d1c0ba3215"
@@ -1105,6 +1109,13 @@ concat-stream@~1.4.5:
     readable-stream "~1.1.9"
     typedarray "~0.0.5"
 
+config-chain@~1.1.5:
+  version "1.1.11"
+  resolved "https://registry.yarnpkg.com/config-chain/-/config-chain-1.1.11.tgz#aba09747dfbe4c3e70e766a6e41586e1859fc6f2"
+  dependencies:
+    ini "^1.3.4"
+    proto-list "~1.2.1"
+
 console-browserify@1.1.x, console-browserify@^1.1.0:
   version "1.1.0"
   resolved "https://registry.yarnpkg.com/console-browserify/-/console-browserify-1.1.0.tgz#f0241c45730a9fc6323b206dbf38edc741d0bb10"
@@ -1385,6 +1396,15 @@ ecc-jsbn@~0.1.1:
   dependencies:
     jsbn "~0.1.0"
 
+editorconfig@^0.13.2:
+  version "0.13.2"
+  resolved "https://registry.yarnpkg.com/editorconfig/-/editorconfig-0.13.2.tgz#8e57926d9ee69ab6cb999f027c2171467acceb35"
+  dependencies:
+    bluebird "^3.0.5"
+    commander "^2.9.0"
+    lru-cache "^3.2.0"
+    sigmund "^1.0.1"
+
 ee-first@1.1.1:
   version "1.1.1"
   resolved "https://registry.yarnpkg.com/ee-first/-/ee-first-1.1.1.tgz#590c61156b0ae2f4f0255732a158b266bc56b21d"
@@ -2175,7 +2195,7 @@ inherits@2.0.1:
   version "2.0.1"
   resolved "https://registry.yarnpkg.com/inherits/-/inherits-2.0.1.tgz#b17d08d326b4423e568eff719f91b0b1cbdf69f1"
 
-ini@~1.3.0:
+ini@^1.3.4, ini@~1.3.0:
   version "1.3.4"
   resolved "https://registry.yarnpkg.com/ini/-/ini-1.3.4.tgz#0537cb79daf59b59a1a517dff706c86ec039162e"
 
@@ -2339,6 +2359,15 @@ jquery@^3.1.1:
   version "3.1.1"
   resolved "https://registry.yarnpkg.com/jquery/-/jquery-3.1.1.tgz#347c1c21c7e004115e0a4da32cece041fad3c8a3"
 
+js-beautify@^1.6.10:
+  version "1.6.12"
+  resolved "https://registry.yarnpkg.com/js-beautify/-/js-beautify-1.6.12.tgz#78b75933505d376da6e5a28e9b7887e0094db8b5"
+  dependencies:
+    config-chain "~1.1.5"
+    editorconfig "^0.13.2"
+    mkdirp "~0.5.0"
+    nopt "~3.0.1"
+
 js-tokens@^3.0.0:
   version "3.0.0"
   resolved "https://registry.yarnpkg.com/js-tokens/-/js-tokens-3.0.0.tgz#a2f2a969caae142fb3cd56228358c89366957bd1"
@@ -2546,6 +2575,12 @@ lower-case@^1.1.1:
   version "1.1.3"
   resolved "https://registry.yarnpkg.com/lower-case/-/lower-case-1.1.3.tgz#c92393d976793eee5ba4edb583cf8eae35bd9bfb"
 
+lru-cache@^3.2.0:
+  version "3.2.0"
+  resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-3.2.0.tgz#71789b3b7f5399bec8565dda38aa30d2a097efee"
+  dependencies:
+    pseudomap "^1.0.1"
+
 lru-cache@^4.0.1:
   version "4.0.2"
   resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-4.0.2.tgz#1d17679c069cda5d040991a09dbc2c0db377e55e"
@@ -2654,7 +2689,7 @@ minimist@^1.1.0, minimist@^1.1.3, minimist@^1.2.0:
   version "1.2.0"
   resolved "https://registry.yarnpkg.com/minimist/-/minimist-1.2.0.tgz#a35008b20f41383eec1fb914f4cd5df79a264284"
 
-"mkdirp@>=0.5 0", mkdirp@^0.5.0, mkdirp@^0.5.1, mkdirp@~0.5.1:
+"mkdirp@>=0.5 0", mkdirp@^0.5.0, mkdirp@^0.5.1, mkdirp@~0.5.0, mkdirp@~0.5.1:
   version "0.5.1"
   resolved "https://registry.yarnpkg.com/mkdirp/-/mkdirp-0.5.1.tgz#30057438eac6cf7f8c4767f38648d6697d75c903"
   dependencies:
@@ -2795,7 +2830,7 @@ node-sass@^4.0.0:
     sass-graph "^2.1.1"
     stdout-stream "^1.4.0"
 
-"nopt@2 || 3", nopt@~3.0.6:
+"nopt@2 || 3", nopt@~3.0.1, nopt@~3.0.6:
   version "3.0.6"
   resolved "https://registry.yarnpkg.com/nopt/-/nopt-3.0.6.tgz#c6465dbf08abcd4db359317f79ac68a646b28ff9"
   dependencies:
@@ -3073,6 +3108,10 @@ promise@^7.1.1:
   dependencies:
     asap "~2.0.3"
 
+proto-list@~1.2.1:
+  version "1.2.4"
+  resolved "https://registry.yarnpkg.com/proto-list/-/proto-list-1.2.4.tgz#212d5bfe1318306a420f6402b8e26ff39647a849"
+
 prr@~0.0.0:
   version "0.0.0"
   resolved "https://registry.yarnpkg.com/prr/-/prr-0.0.0.tgz#1a84b85908325501411853d0081ee3fa86e2926a"
@@ -3441,6 +3480,10 @@ shelljs@0.3.x:
   version "0.3.0"
   resolved "https://registry.yarnpkg.com/shelljs/-/shelljs-0.3.0.tgz#3596e6307a781544f591f37da618360f31db57b1"
 
+sigmund@^1.0.1:
+  version "1.0.1"
+  resolved "https://registry.yarnpkg.com/sigmund/-/sigmund-1.0.1.tgz#3ff21f198cad2175f9f3b781853fd94d0d19b590"
+
 signal-exit@^3.0.0:
   version "3.0.2"
   resolved "https://registry.yarnpkg.com/signal-exit/-/signal-exit-3.0.2.tgz#b5fdc08f1287ea1178628e415e25132b73646c6d"