From 082ea162f5a4cd8eac6c8998d6ca1257ff5f3d6c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lionel=20F=C3=89LICIT=C3=89?=
 <deogracia@users.noreply.github.com>
Date: Sun, 27 Sep 2020 15:22:57 +0200
Subject: [PATCH] docs(contributing): trying to ease the flow for newcomers
 (#286)

* [CONTRIBUTING] Add non specified dependencies

Missing infos when I tried to contribute

* Revert "[CONTRIBUTING] Add non specified dependencies"

This reverts commit 75c9cf8e2b5d85072a10f8ef53fc23ec811c29cd.

* [DOC] remove extra spaces

* [DOC]Add link between contribute and development docs

Try to lead newcomer into the "prefered" way

* [DOC] fix typos

* improve the reading

by taking @mingrammer's hints
---
 CONTRIBUTING.md | 13 +++++++++++--
 DEVELOPMENT.md  |  4 ++--
 2 files changed, 13 insertions(+), 4 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 22aa1475..6a8922fd 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -3,6 +3,10 @@
 You shouldn't edit the node class files (all files under `diagrams/` directory) by
 yourself.
 
+## Set up your environment
+
+* See [DEVELOPMENT][DEVELOPMENT.md]
+
 ## Resources
 
 ### Update nodes
@@ -24,14 +28,17 @@ convert -resize 256 my_big_image.jpg my_image.jpg
 ffmpeg -i my_big_image.jpg -vf scale=w=256:h=256:force_original_aspect_ratio=decrease my_image.png
 ```
 
-Then just run the `./autogen.sh` to generate the added or updated node classes.
+Then just run the `./autogen.sh` to generate the added or updated node classes. (cf. [DEVELOPMENT][DEVELOPMENT.md])
 
 > IMPORTANT NOTE: To run `autogen.sh`, you need [round][round] and
 > [inkscape][inkscape] command lines that are used for cleaning the image
 > resource filenames.
 >
 > macOS users can download the inkscape via Homebrew.
+>
+> Or you should use the docker image.
 
+[DEVELOPMENT.md]: ./DEVELOPMENT.md
 [round]: https://github.com/mingrammer/round
 [inkscape]: https://inkscape.org/ko/release
 
@@ -44,11 +51,13 @@ from `ALIASES` map in [config.py](config.py).
 So, if you want to add new aliases or update existing aliases, you can just add
 or update the `ALIASES` map in [config.py](config.py).
 
-Then just run the `./autogen.sh` to generate the added or updated aliases.
+Then just run the `./autogen.sh` to generate the added or updated aliases. (cf. [DEVELOPMENT][DEVELOPMENT.md])
 
 > IMPORTANT NOTE: To run `autogen.sh`, you need [round][round] and
 > [inkscape][inkscape] command lines that are used for clearning the image
 > resource filenames.
+>
+> Or you should use the docker image.
 
 ## Run Tests
 
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
index 8abd48a7..2ff14060 100644
--- a/DEVELOPMENT.md
+++ b/DEVELOPMENT.md
@@ -7,11 +7,11 @@ You should have docker installed in your system, if not click [here](https://doc
 1. Go to diagrams root directory.
 
 2. Build the docker image.
-    
+
     ```shell
     docker build --tag diagrams:1.0 -f ./docker/dev/Dockerfile .
     ```
-    
+
 3. Create the container, run in background and mount the project source code.
 
     ```shell