Contributing

BUG reports, Feature Request and General discussion

The preferred way to report a problem or request/discuss new features is by opening a new issue at http://github.com/jhcepas/ete/issues. (Please, make sure there is no other issues pointing to the same topic)

Pull Requests (either code or documentation)

Contributions to the main code, unit-tests and documentation are very welcome. The preferred procedure is:

• Clone the master branch
• Add features or correct bugs as necessary (keep your branch in sync with the upstream master branch)
• For new features, add doc string documentation and unittests functions where necessary.
• For new modules, add documentation, unittests and a tutorial section.
• Send a Pull Request for code review and discussion

Running tests (development version)

In order to run the tests, first clone ete and install ETE and external tools under a clean virtual/conda environment:

conda create -n ete_test
conda install -c etetoolkit ete3 ete3_external_apps
git clone https://github.com/jhcepas/ete
pip install -e ete/

Then run all tests:

python -m ete3.test.test_all

In addition to the test execution above, if you wish to calculate test coverage, first install coverage::

conda install coverage
coverage run -m ete3.test.test_all
coverage html

and use a web-browser to open htmlcov/index.html.