Developing and Contributing

Working on Eskapade-ROOT

You have some cool feature and/or algorithm you want to add to Eskapade-ROOT. How do you go about it?

First clone Eskapade-ROOT.

git clone https://github.com:KaveIO/Eskapade-ROOT.git eskapade-root

then

pip install -e eskapade-root

this will install Eskapade in editable mode, which will allow you to edit the code and run it as you would with a normal installation of eskapade.

To make sure that everything works try executing eskapade without any arguments, e.g.

eskapade_run --help

or you could just execute the tests using either the eskapade test runner, e.g.

eskapade_trial .

That’s it.

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. You can find the contact information on the index page.

Note that when contributing that all tests should succeed.