Skip to content

Latest commit

 

History

History
23 lines (15 loc) · 668 Bytes

CONTRIBUTING.md

File metadata and controls

23 lines (15 loc) · 668 Bytes

Contributing to mini3di

For larger bug fixes or new features, please file an issue before submitting a pull request. If the change isn't trivial, it may be best to wait for feedback.

Running tests

Tests are written as usual Python unit tests with the unittest module of the standard library. They can be run the usual way:

$ python -m unittest discover -vv

Coding guidelines

This project targets Python 3.7 or later.

Docstrings

The docstring lines should not be longer than 76 characters (which allows rendering without soft-wrap of the entire module in a 80x24 terminal window).
Docstrings should be written in Google format.