Report Bugs or Errors#

Note

We are sorry to find you on this page! But we are happy to help you with your problem. Please follow the steps below to report a bug or error.

Errors in the Documentation#

The underlying content of the lories documentation website is hosted in the GitHub repository. You can therefore:

🥈 Report the Error#

Prerequisites

  1. A GitHub account

In order to report an error in the documentation, please open a new issue in this repository, describing the error and where you found it. A member of the Brightway developer community will then take care of the issue. Please note that developments are often undertaken on a voluntary basis, so it may take some time for your issue to be resolved.

🥇 Fix the Error Yourself#

Prerequisites

  1. A GitHub account

  2. Basic knowledge of the GitHub contribution workflow (fork, branch, PR)

  3. A fork of the GitHub repository

  4. Basic knowledge of Markdown

In order to fix an error in the documentation, you can make an edit of the underlying content yourself:

  1. Use the ✏️ Edit on GitHub button on the top right of the page to open the corresponding file in the GitHub repository. This shows you which file you need to edit.

  2. Edit the file in your fork of the repository. Finally, create a pull request.

  3. As soon as a member of the lories developer community has merged your pull request, the changes will be visible on the Brightway documentation website.

Bugs in the Code#

The underlying code of the lories framework is hosted in the GitHub repository. You can therefore:

🥈 Report the Bug#

Prerequisites

  1. A GitHub account

  2. Basic knowledge of the Python Error Traceback

In order to report a bug in lories, please open a new issue in this repository, describing the bug and how you found it. Your issue should include:

  1. The complete Python Traceback

  2. A description of the bug

  3. Information your operating system and Python version

  4. The steps required to reproduce the bug

A member of the lories developer community will then take care of the issue. Please note that developments are mostly undertaken on a voluntary basis, so it may take some time for your issue to be resolved.

🥇 Fix the Bug Yourself#

Prerequisites

  1. A GitHub account

  2. Basic knowledge of the GitHub contribution workflow (fork, branch, PR)

  3. A fork of the GitHub repository

Follow the usual GitHub contribution workflow and please take a look at how to contribute to the code.