Skip to content

Contribution Guidelines

Christian Brugger edited this page Jun 22, 2014 · 8 revisions

Some rules and guidelines about changes made to LogikSim:

  • File headers must include:
    • License notice
    • 1-2 lines documenting the purpose of the file
  • Coding style:
    • we follow the official style guide for Python code PEP 8.
  • Test suite:
    • to allow refactoring we require module based unittests for the core API.
    • for graphical user interfaces integration tests are enough.
Clone this wiki locally