start

# Reporting Bugs

Please make sure you are aware of the bug ettiquette then report your bugs at bugs.wordforge.org under the “Translate Toolkit”, “Pootle” or “Pootling” components.

More discussion can be had on the translate-devel mailing list for Translate Toolkit related bugs or translate-pootle mailing list for Pootle related issues or translate-editor mailing list for Pootling related issues.

## Bug Ettiquette

In order to best solve the problem we need good bug reports. Reports that do not give a full picture or which coders are unable to reproduce end up wasting a lot of time. If you, the expert in your bug, spend a bit of time you can make sure your bug gets fixed.

Remember to first see if the bug is not already reported. Perhaps someone already reported it and you can provide some extra information in that bug report. You can also add yourself in the CC field so that you get notified of any changes to the bug report.

If you could not find the bug, you should report it. Look through each of the following sections and make sure you have given the information required.

### Be verbose

Tell us exaclty how came to see this bug. Don’t say:

> The Mozilla DTD files have escaping errors

Rather say:

> I’m working on Firefox 1.5 and in the files somefile.dtd entity XXXX the \n is not escaped correctly it should be \\n

OK so we need to know:

1. What you where working on
2. What tool you used
3. What file has an error
4. What you got, and
5. What you expected to get

### Tell us your version

Use --version to get the version of the tool you are working with.

    moz2po --version        # for Translate Toolkit
    PootleServer --version  # for Pootle versions

We might have fixed this problem already, your version will help us know if their are still problems or whether to ask you to upgrade.

If the correct version is not available to select in bugzilla, please mention the version number in your bug report.

### Attach examples

If possible create a snippet of a file to demonstrate the error. Sending one large file means that the coder has to search for the error. If you can narrow it down to one key section and only attach that it will help.

Please attach all your source files. Ie if the error is in somefile.dtd in Firefox 1.1 please attach that file. It will save the coder having to find the Firefox version, exctract the file and check. If the file is included everything is much quicker. If the file is very large then please place it on a server somewhere for the coder to download.

### Include tracebacks

For the programs in the translate toolkit, use --errorlevel=traceback and copy the traceback to the bug report

    moz2po --errorlevel=traceback

For Pootle, you can get this information with --logerrors or --browsererrors

    PootleServer --logerrors

A traceback will give a much better clue as to what the error might be and send the coder on the right path. It may be a very simple fix, may relate to your setup or might indicate a much more complex problem. Tracebacks help coders get you information quicker.

For Pootling, the traceback might be displayed in the commandline window that you ran it from.

### Reproduce

Tell us exactly how to reproduce the error. In steps if needed or as an example command line. Without being able to reproduce the error it wil not easlly get fixed.

### Be available

If you can be on IRC on #pootle or the relevant mailing list (see above) to answer questions and test possible fixes then this will help to get your problem fixed quickly.