r4 - 29 Aug 2007 - 21:32:09 - PhilippeBossutYou are here: OSAF >  Projects Web  >  OSAFCommunity > GetInvolved > ReportABug > StepByStepBugReporting

Step-by-step instructions for reporting Chandler Desktop bugs that are even more detailed than the ones on Bugzilla's guided "Enter a Bug" page

  1. While creating a bugzilla bug report, set the correct version of Chandler in the version field. You can find the version number using the Chandler menu -> About Chandler option or from the startup screen.
  2. If you know the Component, file the bug under that component because this directly assigns the bug to the developer working on that component. If not, then set the field to 'To be assigned' and we will assign it to the right component and developer.
  3. Set the correct Platform and the OS you are running Chandler on.
  4. Give a very detailed summary in the summary line. For e.g. Chandler crashed when accessing the calendar or Sorting on date in the dashboard gave incorrect results.
  5. In the description section, there are handful of things to note that would help the developers in debugging the problem.
    • Build version - you can get the exact build version from the Chandler menu -> About Chandler
    • Steps to reproduce the problem - This is the most important information you can provide to the developers. Please provide as much detail as you can. Here's an example:
      1. Launched chandler by double clicking the icon on the desktop
      2. Added an event in the calendar for today.
      3. This event showed up in the preview area.
      4. Moved this event from today to a date in the future by dragging the event in the calendar.
      5. Actual Result : The event continued to show in the preview area
      6. Expected Result : The event should no longer be displayed in the preview area.
    • You may provide additional information if you can to help the developer. For e.g.
      1. How long had you been running Chandler before this problem occurred
      2. Is the problem consistently reproducible?
      3. Was Chandler doing anything in the background when this error occured? Look at the status window at the bottom of the application window to see that.
      4. Was the desired behaviour different from the actual result? If so, please explain how?
      5. Did the design confuse you? If so, how?
  6. Attach log files - Under the Test menu -> Show Logging -> Show the Log window shows the chandler log file. If you encounter a problem, look for errors in the log file. It might be helpful to attach it to the bug report. There is an option to copy the log file to clipboard. You can paste that directly in the description section. The window also shows the location of your log files in case you want to upload the log file to the bug report.
  7. Sometimes a developer will request access to your data repository for debugging the problem. We now have a nifty tool for submiting your repository to a machine where the developer has access to it. You first need to backup your repository before submiting it. You can create a backup by pressing the CTRL key when Chandler is starting up. A dialog will come up with many options. Choose ' Make a snapshot of your repository for submiting a bug report' option. That makes a backup of your repository and stores it on your hard disk. Then browse to the repository submit page for submiting it.
    • If you are having problems with a specific item, you may not need to submit your entire repository. Follow instructions here for debugging individual items.
  8. If the problem is related to a specific event in your calendar, it may be helpful to export your calendar as a .ics file and attaching that to the bug report. Note: If you are concerned about exposing your sensitive data in the .ics file, mention you have the ics file in the report and the developer will contact you directly for getting access to it
  9. A talkback window may sometimes appear when an error is encountered while performing certain actions. There is an option to 'Send the feedback' on that window. When you click that button the feedback is saved as an xml file in the same directory as your chandler log file. Attach the feeback file to the bug report.
  10. There may be times when certain actions in Chandler may cause data corruption or inconsistency. It may be worthwhile to run a data check on the repository. Under the Test menu -> Repository use the 'Check Repository' option to check for errors in the repository. If the check comes back with errors, please note it in the bug report.
Edit | WYSIWYG | Attach | Printable | Raw View | Backlinks: Web, All Webs | History: r4 < r3 < r2 < r1 | More topic actions
 
Open Source Applications Foundation
Except where otherwise noted, this site and its content are licensed by OSAF under an Creative Commons License, Attribution Only 3.0.
See list of page contributors for attributions.