Contributing

BUG reports, Feature Request and General discussion

The preferred way to report a problem or request/disccuss new features is by opening a new issue at https://github.com/etetoolkit/ete/issues . Please check if there is already such an open issue before creating a new one.

Pull Requests (either code or documentation)

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

• Clone the repository.
• Add features or correct bugs as necessary (keep your branch in sync with the upstream 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)

To run the tests, after you have a local installation (see README.md for details), you can:

python -m unittest tests.test_arraytable
python -m unittest tests.test_clustertree
python -m unittest tests.test_gtdbquery
python -m unittest tests.test_interop
python -m unittest tests.test_phylotree
python -m unittest tests.test_seqgroup
python -m unittest tests.test_tree
python -m unittest tests.test_treediff
python -m unittest tests.test_orthologs_group_delineation
python -m unittest tests.test_ncbiquery
python -m unittest tests.test_nexus

Eventually we will fix the remaining tests, and then we expect to run them all with:

python -m unittest tests.test_all