Skip to content

Latest commit

 

History

History
30 lines (18 loc) · 839 Bytes

CONTRIBUTING.rst

File metadata and controls

30 lines (18 loc) · 839 Bytes
Raw

Contributing

Thank you for your interest in contributing to xlogit. There are several ways to contribute to this project. For instance:

  • Writing examples or tutorials
  • Expanding documentation or API reference
  • Adding functionalities

All the contributions are managed through pull/merge requests.

For code contributions, setup your Python environment by executing:

pip install -r requirements_dev.txt

Once you have implemented your contribution, open a pull request in the GitHub repository.

Style Guidelines

xlogit follows the PEP8 specification for code styling. Before submitting a pull request, make sure your code is PEP8 compliant by running:

flake8 xlogit

Notes:

  • Indent with 4 spaces
  • Lines up to 80 characters long
  • Docstrings should be written as numpy docstrings