Contributing

This page will show the basic principals, that are used during the development of this package.

The project is hosted on the github.

Test Driven Development

Whole project is written with a test-driven development paradigm. This is especially important, since this project provides an implementation of a complex combinatorial object, which must be reliable in use during research projects.

Project uses unittest framework for implementing TDD paradigm.

Issues reporting

Any found bugs, miss-citations, mistakes in documentation, questions, etc. shall be reported to the issue-tracking system, powered by github.

Code incorporation

There are several rules for new code to be incorporated into this library:

1. All code has to written using the Sphinx style
2. All code must be covered by tests
3. All algorithms and data structures code must have proper citations