msb-public
/
diagrams
mirror of https://github.com/mingrammer/diagrams
1
0
Code Issues Projects Releases Wiki Activity

docs(contributing): trying to ease the flow for newcomers (#286)

Browse Source 
* [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
pull/298/head
Lionel FÉLICITÉ 5 years ago committed by GitHub
parent 2a578930de
commit 082ea162f5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 13 additions and 4 deletions
Show Stats Download Patch File Download Diff File

13
CONTRIBUTING.md
Unescape View File

@ -3,6 +3,10 @@
You shouldn't edit the node class files (all files under `diagrams/` directory) by You shouldn't edit the node class files (all files under `diagrams/` directory) by
yourself. yourself.
## Set up your environment
* See [DEVELOPMENT][DEVELOPMENT.md]
## Resources ## Resources
### Update nodes ### 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 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 > IMPORTANT NOTE: To run `autogen.sh`, you need [round][round] and
> [inkscape][inkscape] command lines that are used for cleaning the image > [inkscape][inkscape] command lines that are used for cleaning the image
> resource filenames. > resource filenames.
> >
> macOS users can download the inkscape via Homebrew. > 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 [round]: https://github.com/mingrammer/round
[inkscape]: https://inkscape.org/ko/release [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 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). 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 > IMPORTANT NOTE: To run `autogen.sh`, you need [round][round] and
> [inkscape][inkscape] command lines that are used for clearning the image > [inkscape][inkscape] command lines that are used for clearning the image
> resource filenames. > resource filenames.
>
> Or you should use the docker image.
## Run Tests ## Run Tests

4
DEVELOPMENT.md
Unescape View File

@ -7,11 +7,11 @@ You should have docker installed in your system, if not click [here](https://doc
1. Go to diagrams root directory. 1. Go to diagrams root directory.
2. Build the docker image. 2. Build the docker image.
```shell ```shell
docker build --tag diagrams:1.0 -f ./docker/dev/Dockerfile . docker build --tag diagrams:1.0 -f ./docker/dev/Dockerfile .
``` ```
3. Create the container, run in background and mount the project source code. 3. Create the container, run in background and mount the project source code.
```shell ```shell

Write Preview
Loading…
Cancel
Save