Contributing to LDF Parser

The following is a set of guidelines for contributing to ldfparser.

How you can contribute

Reporting bugs

Open a new issue using the Bug report template

Before submitting check whether or not this issue has been reported
Use a clear and descriptive title
Provide as much detail as you can regarding the issue

Suggesting enhancements

Open a new issue using the Feature Request template

Before submitting check whether or not this feature has been requested
Use a clear and descriptive title
Provide as much detail as you can regarding the feature
Describe the current behavior and propose an alternative
List all potential applications of the proposed feature

Pull requests

Please follow the process described in Pull Request template.

Verify that status checks are passing.
Request a review and wait for a maintainer to provide feedback

Styleguide

Git commit messages

First line should be below 50 characters in length
Second line should be empty
Further lines should be below 72 characters in length

Python

Code inside source and test folders are linted using Flake8.

Prefer spaces over tabs
Avoid platform-dependent code

Documentation

Non-inline documentation should be in Markdown format located in the docs/ folder or in root
Inline documentation should follow PEP 257