Conventions for Reporting Issues
Writing a Good Bug Report (GBR) is one of the keys to getting the core team to assign a high priority to a bug you may have found. It is key to making a convincing 'argument' that you have, in fact, found a bug. This section is intended to help you help the core team help you.
GBRs have three fundamental characteristics. In short, they are
- Reproducible: A GBR contains a "script" that reproduces the 'bad' behavior every time it's executed. The script should contain initial state information, to the extent that reproducing the problem requires it. Problems that can't be consistently reproduced are, in some circles, assumed to result from operator error. ;-)
- Minimal: A GBR does not contain include anything that's not needed to reproduce the bug.
- Executable: Time is the core team's most precious resource. In general, anything they can run is better than nothing, even if it's large. Of course there's a limit to what they can do; submissions that require specific host platforms, databases, or complicated combinations of libraries, applications, or servers means they're probably not going to "jump on it." Additionally, all of the bug fixes committed to Janus are required to be accompanied by a unit test, to ensure they don't get broken again. In practice, we're not 100% on this, but it is an official rule. Having a small, executable test case makes it trivial for the core team to fulfill that rule.
Writing GBRs is often hard, sometimes frustrating work. Please understand that the core team understands that, and that the contributors who produce GBRs are very much appreciated for helping make Janus better.
Language of your Report
The official and recommended language for the issues is the English.
The following languages are also understood by a member of the Janus development team, and could be used if you cannot write your issue report in English:
Important details to include
When submitting a bug please include the following details :
- Maven version : mvn -version
- Java version : java -version
- Janus version : Check your pom.xml
- A Log trace
It will be much appreciated if you can also include :
- A code that reproduces the bug
- Or even better a test case!
Thanks for your help!!!
PS: This text is largely inspired on JRuby's GBR