Style Guide for PyGromosTools
=============================

Introduction
------------

This file contains the style guide for PyGromosTools. All code should be written according to this style guide. PRs that violate this style guide will be automatically rejected.

WIP: This style guide is still in development. Please be patient and report any issues you find. Thank you!

Python style guide in short
---------------------------

The most important points in short:


#. Clear and descriptive variable names
#. Good docstrings (numpy style)
#. Adhere to PEP8 style guidelines
#. Adhere to the google style guide (https://google.github.io/styleguide/pyguide.html)
#. Check your code against pylint and pre-commit hooks (described in pre-commit-config.yaml)