6
Submitting issues
Mark Olesen edited this page 2021-12-17 09:48:19 +01:00

home issues

The issue tracker is used for reporting bugs and for submitting feature requests.
Please do not submit issues related to general user support.

General guidelines for submitting issues

Feature Requests

We are keen to hear feedback from our users and welcome feature requests, which can also be submitted via the issue tracker.

Bug Reporting bug

When reporting a bug in OpenFOAM, please provide sufficient detail for us to understand your problem. This should include:

  • OpenFOAM version : determine by one of these methods:
    • wmake -build-info or wmake -version
    • From the META-INFO/api-info and META-INFO/build-info files. They contains version (api) information.
    • From any OpenFOAM utility. Eg, blockMesh -help
  • Operating system, compiler, etc.
    • Check your installation by running foamInstallationTest. This will return an extended log, from which you can focus on the "Basic setup" and "Software Components" sections.
    • Find your Linux distribution and version by running lsb_release -a.
  • The circumstances that provoke the bug, i.e. the application being run and under which conditions.
    • Be as specific as possible and provide extended log parts.
  • Where appropriate, please include a small test case.
    • Prepare a minimal working example using a small mesh and just the conditions that trigger the issue, if possible.
    • Use an official tutorial to demonstrate the problem, if possible.
  • Provide a suggested fix (where possible)
    • You can prepare a patch using git-format-patch. Please use the latest state of the develop branch as a starting point. For example, running git format-patch origin will extract all the commits in your local branch but not in the remote repository.
    • See also the Code Development and Coding Style Guide pages.

Copyright (C) 2019-2021 OpenCFD Ltd.