docs(readme): add local-development instructions (#300)

Author: uittorio

README.md

@@ -3,7 +3,6 @@
 [![npm version](https://badge.fury.io/js/ts-auto-mock.svg)](https://badge.fury.io/js/ts-auto-mock)
 [![Downloads](https://img.shields.io/npm/dw/ts-auto-mock.svg)](https://www.npmjs.com/package/ts-auto-mock) 
 
-
 ![slack](docs/slack_small.png) Need help? Join us on [Slack](https://join.slack.com/t/typescripttdd/shared_invite/enQtODk3MjQwNzUwNTk2LTMzNjdlZTNmMmY3Nzg2NDNiZDA1YzJmZjk2NjcwZjQwODQ3YzE5NGZjM2Q4MzZjYWNiMWE4MGU0NjEzM2E5YzE)
 
 A Typescript transformer that will allow you to create mock for any types (Interfaces, Classes, ...) without need to create manual fakes/mocks.
@@ -36,6 +35,10 @@ mock.details // "{phone: 0} "
 ## [Changelog](CHANGELOG.md)
 
 ## [Roadmap](https://github.com/Typescript-TDD/ts-auto-mock/wiki/Roadmap)
+
+#### Do you want to contribute?
+* [Check how to make changes to the code base](https://typescript-tdd.github.io/ts-auto-mock/local-development)
+
 ## Authors
 
 * [**Vittorio Guerriero**](https://github.com/uittorio)

ui/doczrc.js

@@ -19,7 +19,8 @@ export default {
         { name: 'Types not supported'},
         { name: 'Config'},
         { name: 'Performance'},
-        { name: 'Definitely Typed'}
+        { name: 'Definitely Typed'},
+        { name: 'Local development'}
     ],
     repository: "https://github.com/Typescript-TDD/ts-auto-mock"
 }

ui/src/views/local-development.mdx

@@ -0,0 +1,67 @@
+---
+name: Local development
+route: /local-development
+---
+
+# Local development
+
+If you want to add a new functionality of fix a bug in ts-auto-mock you are in the right place
+
+## Pre requisite
+- node >= 10
+- npm
+- the repo cloned locally
+
+## Install local dependencies
+- Make sure you are in the root folder
+- run npm install
+```
+npm install
+```
+
+## Build the transformer
+- run npm run build
+```
+npm run build
+```
+
+## Make a change
+Ts auto mock has multiple modules, each of them has a different meaning and depending of what you are editing you can just re build the specific one
+- transformer
+- repository
+- extension
+- merge
+
+If you are editing the transformer
+
+```
+npm run build:transformer
+```
+
+If you are editing anything else
+```
+npm run build:modules
+```
+
+## Test your changes
+There are 2 ways to test the effectiveness of your changes
+- Use the existing test system
+    - add a test
+    - run all the tests
+    ```
+        npm run test
+        // use npm run test:transformer if you are just editing the transformer
+    ```
+- use the Playground
+    - open the file [playground.test.ts](https://github.com/Typescript-TDD/ts-auto-mock/blob/master/test/playground/playground.test.ts)
+    - make your changes
+    - run test playground to see the test passing
+    ```
+    npm run test:playground
+    ```
+    - run build playground to see the output of the generate code
+    ```
+    npm run build:playground
+    ```
+
+That's it.