Skip to content

Latest commit

 

History

History
22 lines (16 loc) · 818 Bytes

CONTRIBUTING.md

File metadata and controls

22 lines (16 loc) · 818 Bytes

Contributing

First of all thank you for considering to contribute! The project is quite big for one person a I would really appreciate any help.

Code style

  • Just follow PEP8
  • Well because of legacy code package actually use camelCase for class methods (PEP8 alert)
  • Function comments are welcomed and should follow numpy style

Testing

  • pytest is preferred way to do it (run pytest test)
  • Current tests coverage can be definitely improved
  • For coverage check use py.test --cov=lcc test

Where to contribute

The repo can be divided into 3 areas where it can be contributed:

  1. lcc package
  2. lcc CLI
  3. Web Interface

There are a lots of "ugly" parts of the code which should be refactored...