CONTRIBUTING.md

Contributing

A set of guidelines to follow when contributing to lowbar.

Keep code complexity minimal

lowbar's main goal is to be a simple solution that is bug-free and easily maintained. Extremely complex or spaghetti code makes the codebase harder to maintain, and increases the possibilities of bugs in future updates.

Consistent styling, annotation and syntax

Variable and function names should be written in snake case:

my_var
my_func()

Add docstrings to functions:

def my_func(self, arg1: str, arg2: int):

    """
    blah blah
    """

    // code //

Annotate variables when defining them:

my_var1: str = "blah blah"
my_var2: int = 99

Specify function return value types:

def my_func(self, arg1: str, arg2: int) -> list:
   
   // code//
   
   return my_list

No dependencies apart from the Python Standard Library

Check docs.python.org/3/library/index.html for reference.