Bug Reporting Guidelines

These guidelines are brought to you by Diego Ruiz. If you have questions or improvement suggestions, feel free to edit this page.

Did you find a bug in iDempiere

1. Do not open up a JIRA ticket if the bug is a security vulnerability in iDempiere, and instead refer to our security policy page.
2. Ensure the bug was not already reported by searching on JIRA under Issues.

Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.

1. If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or a executable test case demonstrating the expected behaviour that is not occurring, it is a good idea if you can reproduce the bug in one of the test servers before you create a ticket.

Before Submitting A Bug Report

1. Check if you can reproduce the problem in the latest version of iDempiere.
2. Check the FAQs on the forum' for a list of common questions and problems.

How Do I Submit A (Good) Bug Report?

Bugs are tracked as JIRA issues.

Explain the problem and include additional details to help maintainers reproduce the problem:

1. Use a clear and descriptive title for the issue to identify the problem.
2. Describe the exact steps which reproduce the problem in as many details as possible.
3. Provide specific examples to demonstrate the steps. If possible reproduce the problem with Garden data.
4. Describe the behaviour you observed after following the steps and point out what exactly is the problem with that behaviour.
5. Explain which behaviour you expected to see instead and why.
6. Include screenshots and videos - if possible, which show you following the described steps and clearly demonstrate the problem.
7. If you're reporting that iDempiere crashed, include a crash report with a stack trace from the log files.
8. If the problem is related to performance or memory, include valid numbers.
9. If the problem wasn't triggered by a specific action, describe what you were doing before the problem happened and share more information using the guidelines below.

Provide more context by answering these questions:

1. Can you reproduce the problem in the test sites?
2. Did the problem start happening recently (e.g. after updating to a new version of iDempiere) or was this always a problem?
3. If the problem started happening recently, can you reproduce the problem in an older version of iDempiere? What's the most recent version in which the problem doesn't happen?
4. Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.