Contributing

[EvenBetterClub]

Issues #108 - I was unable to get a successful build working so could contribute - Have written a more details setup guide - but it still needs work to be complete - can anyone help?

[rickhull]

I got tests working on NixOS 20.03 with less work.

  # List packages installed in system profile. To search, run:
  environment.systemPackages = with pkgs; [
    # ...
    # added for diagrams
    python3
    poetry
    graphviz
];

git clone $DIAGRAMS
cd diagrams
poetry shell
python -m unittest tests/*.py

[louisguitton]

Thanks for your PR, it helped me fill in the blanks while getting setup. I'm on MacOS and here are the steps I follow to set myself up, if that can be helpful to anybody:

Dev environment

You need poetry installed and a virtual environment (both are not specific to this project so I'm not including it here), and then in your diagrams folder run:

poetry install
python -m unittest tests/*.py

Contributing environment

go get github.com/mingrammer/round
brew cask install inkscape
./autogen.sh

[louisguitton]

you can let poetry handle this by setting up your dev environment with

poetry install

[louisguitton]

you saved me probably at least (:trollface: ) 15 minutes on this one 🙏 .
The error message if you don't do this is:

→ ./autogen.sh
image magick is not installed

A quick search in the codebase shows that it's fixed by installing convert or ImageMagick, which I did with

brew install imagemagick

[bdsoha]

Suggested change

	# However it still needs testing again; and also needs worked example on actually contributing 'value' and not putting noise back into the repository!
	# However, it still needs testing again; and also needs worked example on actually contributing 'value' and not putting noise back into the repository!

[bdsoha]

Suggested change

	Whilst using Diagrams is easy and some folks will find setting up and extending Diagrams easy - for others with Python, Bash and Go dependancies it is harder...
	While using Diagrams is easy and some folks will find setting up and extending Diagrams easy - for others with Python, Bash and Go dependencies it is harder...

[bdsoha]

Suggested change

	Thanks: Thanks to ViktorOrda for assist on getting this to work.
	Thanks: Thanks to @ViktorOrda for assist on getting this to work.

[bdsoha]

Suggested change

	So a worked guide to setting up a VM with linux so you can contribute to Diagrams.
	So, a worked guide to setting up a VM with Linux so you can contribute to Diagrams.

[bdsoha]

Suggested change

	and all the tests should pass.
	and all the tests should pass.