Nie możesz wybrać więcej, niż 25 tematów Tematy muszą się zaczynać od litery lub cyfry, mogą zawierać myślniki ('-') i mogą mieć do 35 znaków.

CONTRIBUTING.md 1.5 KiB

123456789101112131415161718192021222324252627282930313233
  1. # Contributiton Guide
  2. You shouldn't edit the node class files (all files under `diagram` directory) by yourself.
  3. ## Resources
  4. ### Update nodes
  5. All node classes was auto-generated from image resource files. For example, the `diagram.aws.compute.EC2` class was auto-generated based on `resources/aws/compute/ec2.png` image resource file.
  6. So, if you want to add new node resources or update existing node resources, you can just add or update the image files in `resources/<provider>/<type>/<image>`.
  7. Then just run the `./autogen.sh` to generate the added or updated node classes.
  8. > IMPORTANT NOTE: To run `autogen.sh`, you need [round](https://github.com/mingrammer/round) and [inkscape](https://inkscape.org/ko/release) command lines that are used for clearning the image resource filenames.
  9. >
  10. > macOS users can download the inkscape via Homebrew.
  11. ### Update Aliases
  12. Some node classes have alias. For example, `aws.compute.ECS` class is an alias of `aws.compute.ElasticContainerService` class. Aliases also were auto-generated from `ALIASES` map in [config.py](config.py).
  13. 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).
  14. Then just run the `./autogen.sh` to generate the added or updated aliases.
  15. > IMPORTANT NOTE: To run `autogen.sh`, you need [round](https://github.com/mingrammer/round) and [inkscape](https://inkscape.org/ko/release) command lines that are used for clearning the image resource filenames.
  16. ## Run Tests
  17. ```shell
  18. $ python -m unittest tests/*.py -v
  19. ```