Difference between revisions of "Bug Reporting Guidelines"
From iDempiere en
Diego.ruiz (talk | contribs) |
Diego.ruiz (talk | contribs) |
||
| Line 2: | Line 2: | ||
= Did you find a bug in iDempiere = | = Did you find a bug in iDempiere = | ||
| − | + | * '''Do not open up a JIRA ticket if the bug is a security vulnerability in iDempiere''', and instead refer to our [https://wiki.idempiere.org/en/How_to_report_a_vulnerability security policy] page. | |
| − | + | * '''Ensure the bug was not already reported''' by searching on JIRA under [https://idempiere.atlassian.net/issues/ Issues]. | |
| + | * 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 [https://www.idempiere.org/test-sites test servers] before you create a ticket. | ||
| + | |||
''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.'' | ''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.'' | ||
| − | |||
== Before Submitting A Bug Report == | == Before Submitting A Bug Report == | ||
| − | + | * '''Check if you can reproduce the problem in the latest version of iDempiere'''. | |
| − | + | * ''Check the [https://www.idempiere.org/forums FAQs on the forum]''' for a list of common questions and problems. | |
== How Do I Submit A (Good) Bug Report? == | == How Do I Submit A (Good) Bug Report? == | ||
| Line 18: | Line 19: | ||
Explain the problem and include additional details to help maintainers reproduce the problem: | Explain the problem and include additional details to help maintainers reproduce the problem: | ||
| − | + | * '''Use a clear and descriptive title''' for the issue to identify the problem. | |
| − | + | * '''Describe the exact steps which reproduce the problem''' in as many details as possible. | |
| − | + | * '''Provide specific examples to demonstrate the steps'''. If possible reproduce the problem with Garden data. | |
| − | + | * '''Describe the behaviour you observed after following the steps''' and point out what exactly is the problem with that behaviour. | |
| − | + | * '''Explain which behaviour you expected to see instead and why.''' | |
| − | + | * '''Include screenshots and videos''' - if possible, which show you following the described steps and clearly demonstrate the problem. | |
| − | + | * '''If you're reporting that iDempiere crashed''', include a crash report with a stack trace from the log files. | |
| − | + | * '''If the problem is related to performance or memory''', include valid numbers. | |
| − | + | * '''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: | Provide more context by answering these questions: | ||
| − | + | * '''Can you reproduce the problem in [https://www.idempiere.org/test-sites the test sites]?''' | |
| − | + | * '''Did the problem start happening recently''' (e.g. after updating to a new version of iDempiere) or was this always a problem? | |
| − | + | * 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? | |
| − | + | * '''Can you reliably reproduce the issue?''' If not, provide details about how often the problem happens and under which conditions it normally happens. | |
Revision as of 18:03, 17 December 2019
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
- Do not open up a JIRA ticket if the bug is a security vulnerability in iDempiere, and instead refer to our security policy page.
- Ensure the bug was not already reported by searching on JIRA under Issues.
- 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.
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.
Before Submitting A Bug Report
- Check if you can reproduce the problem in the latest version of iDempiere.
- 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:
- Use a clear and descriptive title for the issue to identify the problem.
- Describe the exact steps which reproduce the problem in as many details as possible.
- Provide specific examples to demonstrate the steps. If possible reproduce the problem with Garden data.
- Describe the behaviour you observed after following the steps and point out what exactly is the problem with that behaviour.
- Explain which behaviour you expected to see instead and why.
- Include screenshots and videos - if possible, which show you following the described steps and clearly demonstrate the problem.
- If you're reporting that iDempiere crashed, include a crash report with a stack trace from the log files.
- If the problem is related to performance or memory, include valid numbers.
- 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:
- Can you reproduce the problem in the test sites?
- Did the problem start happening recently (e.g. after updating to a new version of iDempiere) or was this always a problem?
- 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?
- Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.
