Submitting_bugs_and_feature_requests

Submitting Bugs and Feature Requests

If you have found an issue with OWLNext, and you are pretty sure it is a bug, submit a ticket to the bug tracker. If you have a suggestion for improving the library then submit a ticket to the feature tracker.

• Submitting Bugs and Feature Requests
  • Guideline for submissions
  • Ticket entry fields
    • Milestone
    • Status
    • Owner
    • Priority
    • Labels
    • Mark as Private
    • Description
    • Attachments

---

Guideline for submissions

You should use a SourceForge account to submit bug and feature request tickets. It is easier for the project developers to track tickets that way, and it discourages spam.

When submitting a bug ticket, it will be easier for the developers to investigate and fix the issue if you provide a simple code example that demonstrates the problem. If not, you should provide thorough information about how to reproduce the problem. Always state the version of the library and the brand and version of the compiler you are using. You can also attach proposed fixes for the bugs either as full source code or preferably unidiff patch files.

If you are not sure whether a particular issue is a bug, you should describe the issue in a post to the Open Discussion forum. Should it be confirmed as a bug, then the developers will submit a ticket to the bug tracker on your behalf. See "How do I report an issue?" in our FAQ for more information on how to communicate issues.

---

Ticket entry fields

This section describes the proper use of the ticket tracker fields.

Milestone

Set this field to "unspecified". The field will be updated by the developers. It is used to assign the issue to a future release, i.e. the expected release in which the resolution of the issue will be implemented.

Status

Leave the status set to "open". The field will be updated by the developers as the ticket is dealt with.

The meaning of the relevant statuses are:

1. open - the issue is not yet resolved, but work on the resolution may be ongoing.
2. pending - the issue has been resolved, and the resolution is awaiting review and release.
3. closed - the issue has been resolved and closed.
4. wont-fix - the issue is either invalid, no longer relevant, or a bug/feature that will not be addressed.

The other statuses (accepted and unread') are currently not in use.

Owner

Leave this field empty. The developers will update this field when the issue is assigned to someone for investigation and resolution. In general, a blank field means that the issue is currently not being worked on.

Priority

In general you should leave this field at 1. Prioritisation is currently not much exercised.

Labels

You can add multiple keywords here to categorise the issue. Do not enter keywords separated by space. Instead enter a keyword and press Enter. Then you can add another if you wish. We recommend the use of the following labels:

• 64-bit - the issue concerns the 64-bit build mode.
• API - the issue concerns the public (or protected) interface of the library, i.e. classes, functions, parameters, etc.
• Build - the issue causes build errors or warnings, or is otherwise related to OWLMaker or the build scripts.
• Crash - the issue causes (or may cause) applications to crash.
• CoolPrj - the issue concerns the CoolPrj extension library.
• Documentation - the issue concerns the reference documentation (Doxygen).
• Exceptions - the issue concerns exception handling.
• GDI - the issue concerns GDI encapsulations (TDC classes) or functionality for graphics.
• GUI - the issue concerns the graphical user interface, i.e. it is visual or behavioural in character, e.g. a control is drawn incorrectly, or the UI behaves incorrectly (e.g. drag and drop does nothing).
• Internal - this is a general tag for non-visual issues, e.g. a memory leak or truncation.
• Multi-threading - the issue concerns concurrency, e.g. data-races and deadlocks.
• OCF - the issue concerns the OCFNext extension library.
• OWLExt - the issue concerns the OWLExt extension library.
• Refactoring - the issue concerns change or rewrite for improvement of the code (e.g. better naming, simpler API, smarter implementation), without changing the functionality.
• Regression - the issue was introduced by another change, e.g. a bug fix. Refer to the ticket, revision or version that introduced the issue.
• Translation - the issue concerns internationalisation.

Mark as Private

Do not select this option. Private tickets are for the developers only.

Description

Please enter as complete description as possible in this field. Be careful to use proper Markdown syntax to format the text. Otherwise you may get formatting surprises, esp. for code.

Attachments

If you have a lot of code, consider attaching it in a separate file rather than including it in the description text. Proposed fixes should be attached as unidiff patch files. Please state the version (revision number) of the code the patch is based on.