Browse Source

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 75c9cf8e2b.

* [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É 4 years ago
committed by GitHub
parent
commit
082ea162f5
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 13 additions and 4 deletions
  1. +11
    -2
      CONTRIBUTING.md
  2. +2
    -2
      DEVELOPMENT.md

+ 11
- 2
CONTRIBUTING.md View File

@@ -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



+ 2
- 2
DEVELOPMENT.md 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.

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


Loading…
Cancel
Save