Version 6, last updated by ricardojlrufino at October 14, 2011 20:41 UTC

Reporting Bugs or Requesting Features

Bug Submission Steps

  1. Find possible bug
  2. Search in the relevant project thoroughly for similar issues
  3. Once certain of a bug:

    • Create a ticket (one ticket per bug)
    • Keep it as concise and as factual as possible
    • Include your usecase, and all the information described in checklist below
    • Watch ticket, to show your support for the ticket’s resolution
  4. If coming here to create a ticket from another forum, help others by posting the ticket’s URL back in the source location.

Creating a Good Use-case

A “usecase” is a working script that reliably reproduces a specific bug. The best usecase is one that contains the least possible code while still demonstrating the bug.

  • Try the issue in a new workspace or a new project to see if that make a difference
  • Include exact steps to perform the actions in your workspace. In particular, when referencing editor errors, a sample document with cursor positions, and expected and actual output is invaluable
  • Try and create the smallest possible sample that illustrates the problem

Creating a Ticket

  • Click on link tickets in main menu.
  • Select from the list of ticket types in the top right-hand corner, although usually only BugImprovement or New Feature will be appropriate
  • Complete as many fields as you can. Refer to checklist for help with this
  • As the reporter, you will automatically receive any updates to the ticket. However, it’s always a good idea to also watch the ticket if its resolution is crucial to your projects, in order for our team to gauge the issue’s impact on the community from the watchers list

Thank you for your time!