Contributing to llvmlite

llvmlite originated to fulfill the needs of the Numba project. It is maintained mostly by the Numba team. We tend to prioritize the needs and constraints of Numba over other conflicting desires.

We do welcome any contributions in the form of bug reports or pull requests.

Communication methods

Mailing list

Send email to the Numba users public mailing list at numba-users@continuum.io. You are welcome to send any questions about contributing to llvmlite to this mailing list.

You can subscribe and read the archives on Google Groups. The Gmane mirror allows NNTP access.

Bug reports

We use the Github issue tracker to track both bug reports and feature requests. If you report an issue, please include:

  • What you are trying to do.
  • Your operating system.
  • What version of llvmlite you are running.
  • A description of the problem—for example, the full error traceback or the unexpected results you are getting.
  • As far as possible, a code snippet that allows full reproduction of your problem.

Pull requests

To contribute code:

  1. Fork our Github repository.
  2. Create a branch representing your work.
  3. When your work is ready, submit it as a pull request from the Github interface.

Development rules

Coding conventions

  • All Python code should follow PEP 8.
  • Our C++ code does not have a well-defined coding style.
  • Code and documentation should generally fit within 80 columns, for maximum readability with all existing tools, such as code review user interfaces.

Platform support

Llvmlite will be kept compatible with Python 2.7, 3.4 and later under at least Windows, macOS and Linux. It needs to be compatible only with the currently supported LLVM version—the 3.8 series.

We do not expect contributors to test their code on all platforms. Pull requests are automatically built and tested using Travis-CI, which addresses Linux compatibility. Other operating systems are tested on an internal continuous integration platform at Continuum Analytics®.

Documentation

This llvmlite documentation is built using Sphinx and maintained in the docs directory inside the llvmlite repository.

  1. Edit the source files under docs/source/.

  2. Build the documentation:

    make html
    
  3. Check the documentation:

    open _build/html/index.html