Contributing

Welcome to the IBL project. The main project repository is located on GitHub. If you are interested in contributing, let us know what you would like to do.

Code of Conduct

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.

For information see the code of conduct file in the root directory of this project.

Style Guide

To Do

C/C++ Code

TBD

Python Code

For Python code, we follow the Style Guide for Python Code, PEP 8. Code should should produce no warning when analyzed by pycodestyle. In addition the code should produce no messages from Pylint. These should be checked before committing code, and most IDEs support these. Both of these tools are common in most Python installations. They are also available from PyPI.

Matlab Code

TBD

CMake Code

TBD

LaTeX Files

TBD

Scripts/Other Files

TBD

Submitting Changes

Before making contributions to this project, please discuss your plans with the maintainers. This is best done with an issue on the project repository or email to the maintainers.

Bug Reports

Bug reports can be submitted via the issue tracker. Please provide as much information as possible to reproduce the error. A minimal working example will make it easier to track down the problem.

Testing

Most directories should have a testing directory that contains the unit tests and other tests used in the project.