|
|
<!-- --- title: Submitting Issues -->
|
|
|
|
|
|
[![home](/icons/home.svg "wiki home")](/home)
|
|
|
[![issues](/icons/message-square.svg "issues")][foam-issues]
|
|
|
|
|
|
|
|
|
The [issue tracker][foam-issues] is used for reporting bugs and for
|
|
|
submitting feature requests. <br/>
|
|
|
Please *do not* submit issues related to general user support.
|
|
|
|
|
|
## General guidelines for submitting issues
|
|
|
|
|
|
- Use a title that accurately describes your issue
|
|
|
- Use [Markdown](https://docs.gitlab.com/ee/user/markdown.html) to
|
|
|
format your message,
|
|
|
_especially_ for [code snippets](https://docs.gitlab.com/ee/user/markdown.html#code-spans-and-blocks)
|
|
|
- Find out more about [using the GitLab environment to create issues](https://docs.gitlab.com/ee/user/project/issues/issue_data_and_actions.html).
|
|
|
|
|
|
|
|
|
## Feature Requests
|
|
|
|
|
|
We are keen to hear feedback from our users and welcome
|
|
|
***feature requests***, which can also be submitted via the
|
|
|
[issue tracker][foam-issues].
|
|
|
|
|
|
|
|
|
## Bug Reporting ![bug](/icons/bug.svg "bug")
|
|
|
|
|
|
When [reporting a bug in OpenFOAM][foam-issues],
|
|
|
please provide sufficient detail for us to understand your problem.
|
|
|
This should include:
|
|
|
- OpenFOAM version
|
|
|
- Find your OpenFOAM version by running `foamVersion` or `wmake -version`
|
|
|
- Operating system, compiler, etc.
|
|
|
- OpenFOAM version : determine by one of these methods:
|
|
|
- `wmake -build-info` or `wmake -version` or `foamVersion`
|
|
|
- From the `META-INFO/api-info` file. It contains version (api) information.
|
|
|
- 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, e.g. what application was being run and under what conditions.
|
|
|
- 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.
|
|
|
- Where appropriate, please include a ***small*** test case.
|
|
|
- Prepare a [minimal working example][MWE] using a small mesh and just the conditions that trigger the issue, if possible.
|
|
|
- Use an official tutorial to demonstrate the problem, if possible.
|
|
|
- and, if possible, provide a suggested fix.
|
|
|
- Provide a suggested fix (where possible)
|
|
|
- You can prepare a patch using [git-format-patch](https://git-scm.com/docs/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 pages [Code Development][code-devel] and [Coding Style Guide][code-style].
|
|
|
|
|
|
*Please do not submit issues related to general user support.*
|
|
|
These will be monitored and closed accordingly.
|
|
|
|
|
|
|
|
|
## General guidelines for submitting issues
|
|
|
|
|
|
- Use a title that precisely describes your issue
|
|
|
- Use [Markdown](https://docs.gitlab.com/ee/user/markdown.html) to format your message (and especially [code snippets](https://docs.gitlab.com/ee/user/markdown.html#code-spans-and-blocks))
|
|
|
- Find out more about [using the GitLab environment to create issues](https://docs.gitlab.com/ee/user/project/issues/issue_data_and_actions.html).
|
|
|
|
|
|
|
|
|
## Feature Requests
|
|
|
|
|
|
We are keen to hear feedback from our users and welcome
|
|
|
[feature requests](/page-feature-requests)!
|
|
|
- See also the [Code Development][code-devel] and [Coding Style Guide][code-style] pages.
|
|
|
|
|
|
|
|
|
----
|
... | ... | @@ -46,5 +53,7 @@ Copyright (C) 2019-2020 OpenCFD Ltd. |
|
|
|
|
|
[foam-issues]: https://develop.openfoam.com/Development/openfoam/-/issues
|
|
|
|
|
|
[MWE]: https://en.wikipedia.org/wiki/Minimal_working_example
|
|
|
|
|
|
[code-devel]: /coding/git-workflow
|
|
|
[code-style]: /coding/style/style |