Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "RAP Bug Reporting Howto"
(→Search for existing bug) |
|||
Line 7: | Line 7: | ||
In order to avoid duplicates, check whether a similar bug has already been reported. | In order to avoid duplicates, check whether a similar bug has already been reported. | ||
− | + | ||
+ | * [https://bugs.eclipse.org/bugs/buglist.cgi?query_format=advanced&short_desc_type=allwordssubstr&short_desc=&product=RAP&long_desc_type=allwordssubstr&long_desc=&bug_file_loc_type=allwordssubstr&bug_file_loc=&status_whiteboard_type=allwordssubstr&status_whiteboard=&keywords_type=nowords&keywords=plan&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_severity=blocker&bug_severity=critical&bug_severity=major&bug_severity=normal&bug_severity=minor&bug_severity=trivial&bug_severity=enhancement&emailtype1=substring&email1=&emailtype2=substring&email2=&bugidtype=include&bug_id=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&cmdtype=doit&order=Bug+Number&field0-0-0=noop&type0-0-0=noop&value0-0-0=|list of all open bug reports] | ||
+ | |||
+ | * [https://bugs.eclipse.org/bugs/buglist.cgi?query_format=advanced&short_desc_type=allwordssubstr&short_desc=&product=RAP&long_desc_type=allwordssubstr&long_desc=&bug_file_loc_type=allwordssubstr&bug_file_loc=&status_whiteboard_type=allwordssubstr&status_whiteboard=&keywords_type=allwords&keywords=&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_severity=enhancement&emailtype1=substring&email1=&emailtype2=substring&email2=&bugidtype=include&bug_id=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&cmdtype=doit&order=Reuse+same+sort+as+last+time&field0-0-0=noop&type0-0-0=noop&value0-0-0=|list of open enhancement requests] | ||
+ | |||
+ | If you found a bug that describes ''exactly'' your problem, and you have additional information, please leave a comment. | ||
=== Make sure it's working with SWT / RCP === | === Make sure it's working with SWT / RCP === |
Revision as of 07:27, 25 June 2009
This page explains how to write a useful bug report for RAP. See also the FAQ How do I report a bug in Eclipse? and Bug Reporting FAQ.
Contents
Before you submit a bug
Search for existing bug
In order to avoid duplicates, check whether a similar bug has already been reported.
If you found a bug that describes exactly your problem, and you have additional information, please leave a comment.
Make sure it's working with SWT / RCP
We provide strict subsets of SWT, JFace and Workbench bundles. Thus, things should work just as they do in SWT and RCP. If you find that RAP does not work as you expect in some point, please make sure that the same code works with SWT / RCP. If you see the same problem in the original, then it is not a RAP bug.
Where to submit your bug
Start at the RAP project's bug page.
What to include in the bug report
Description
The bug description should be as short and exact as possible. It should contain:
- Your environment (operating system, browser type and version, RAP version)
- The steps to reproduce the behavior described
- The expected outcome / solution
Example:
Environment: Firefox 3.0.1 on MacOS X Steps to reproduce: * Create a label * call setText( "foo" ) on the label * call setText( "bar" ) on the label -> The label still shows the first text ("foo") until a button is pressed Expected: The label should show "bar" immediately
Provide a code snippet
If the bug only occurs under certain circumstances, it's helpful if you can provide a snippet to reproduce.
- The snippet should be as simple as possible.
- The snippet should be self-contained (i.e. not rely on third-party code) and fit into one single class.
- The snippet should be runnable without hacking, i.e. it should implement IEntryPoint.
- The snippet should run in a J2RE 1.4 environment
Example:
public class ExampleSnippet implements IEntryPoint { public int createUI() { Display display = new Display(); Shell shell = new Shell( display ); shell.setLayout( new GridLayout() ); final Label label = new Label( shell, SWT.PUSH ); label.setText( "Label" ); label.setLayoutData( new GridData( SWT.FILL, SWT.TOP, true, false ) ); Button button = new Button( shell, SWT.PUSH ); button.setText( "Test" ); button.addSelectionListener( new SelectionAdapter() { public void widgetSelected( SelectionEvent e ) { label.setText( "Button pressed" ); } } ); while( !shell.isDisposed() ) { if( !display.readAndDispatch() ) { display.sleep(); } } return 0; } }
Provide a screenshot
Remember that we don't have your exact desktop environment and browser. If you describe some visual misbehavior, a screenshot helps us understand your problem.
The best image formats for screenshots is PNG or GIF. JPG is for photographs (is has lossy compression), uncompressed image formats like BMP, TIFF, etc. are just too big and take too long to download.