Skip to content

Latest commit

 

History

History
33 lines (20 loc) · 1.7 KB

CONTRIBUTING.md

File metadata and controls

33 lines (20 loc) · 1.7 KB
Raw

Contributing

Code style

  • Try to follow the PEP 8 style guide. A usefull tool for automated formatting is autopep8. We do allow lines upto 120 characters.
  • Document functions using the Google docstring convention
  • Add unit tests using the unittest framework

Submitting code

If you would like to contribute, please submit a pull request. (See the Github Hello World example, if you are new to Github).

By contributing to the repository you state you own the copyright to those contributions and agree to include your contributions as part of this project under the BSD license.

Bugs reports and feature requests

To submit a bug report or feature request use the Github issue tracker. Search for existing and closed issues first. If your problem or idea is not yet addressed, please open a new issue.

Testing

Continuous integration and testing for the C++ library is performed on Travis and for the Python package on AppVeyor.

To perform tests run pytest. To obtain a coverage report, run

$ coverage run --source='./oapackage' -m pytest
$ coverage report --omit oapackage/markup.py,oapackage/_scanf.py

Contact

For further information please contact Pieter Eendebak, pieter.eendebak at tno.nl