HOW TO: Report Bugs / Add Feature Requests

Discuss KeyNote NF bugs
Locked
User avatar
dpradov
Site Admin
Posts: 17
Joined: 27 Aug 2010, 16:40
Location: Seville (Spain)

HOW TO: Report Bugs / Add Feature Requests

Post by dpradov »

If you encounter a bug, please make sure you include all steps needed to reproduce the problem. Read Reporting Bugs, below, for some clarity.

If you have a great new idea for KeyNote NF, please post it in these forums to get a feel for its viability. Feature requests should be very specific to functionality as opposed to vague ideas. In theses forums your idea can be discussed and refined with others's help. It will be also possible to create polls to determine the most accepted solution, before trying to implement it.

For bug reports and feature requests, make sure to create a corresponding issue in GitHub so it does not get lost. Bugs would be classified as "defects" and feature requests as "enhancements".


:!:
Please, don't report any issue just because you don't know how to do something. Perhaps the functionality you want exists and you don't know how to find it, or what you think that is something incorrect could be reasonable, if explained. For that reasons I recommend that you explore first your problems and ideas in the forum.

Although actually anyone can report in the issue tracker, I would prefer that the trend was that only certain users, advanced users, can do it, from what they see in the forums. Actually there are too many duplicate issues, and alleged defects that are not, and that are reported due to ignorance about KeyNote's operating. All this is very time consuming, and obstruct the development tasks (and I have too little time)
The use of images is also much more flexible in these forums that in the issue tracker. So, I think that probably it is better to first report in the forum, indicating also as a label the severity level (eg. "[Critical]" ), and then (if it is really a bug) in the tracker, including a link to the topic.

These forums and a next Wiki will help in creating a knowledge database that will resolve many of the usual doubts and problems reported. KeyNote NF's help file must be updated but in the meantime you shoud remember that there is enough information in the original Tranglo's Keynote website, and in the file 'KN_Handbook.knt', included in all the program releases. Some things no longer apply but most remain valid.


Reporting Bugs

What should I include in a bug report as a minimum?

Your bug report should include:
  • The version and build of KeyNote NF that you are running.
  • The operating system of your PC.
  • A description of the bug. Where possible include screen captures (.jpg, .gif or .png) with highlights and notes to help communicate and illustrate the problem/bug.
  • A description of events/actions at the time the bug was observed.
  • If possible, a description of events/actions that can reproduce the bug.
Read How to Report Bugs Effectively (Third Party Site) to learn how to effectively report bugs.


What severity level should I use when reporting bugs?

Please use the following as a guideline for choosing severity levels for bugs on the bug tracker:
  • Critical
    • constant crashing/assertion error/freezing
    • prevents files from downloading/uploading
    • corrupts/deletes .knt files or linked files
    • makes KeyNote completely unusable
    • blue screen of death
    • blocker - would postpone release
    • crashes computer/windows
    • causes computer to burst into flames
  • High
    • crash/assertion error occurs occasionally
    • crashes on a certain event (eg. deleting a node)
    • important feature is broken (eg. inserting keynote links)
  • Medium
    • minor feature is broken (eg. outline numbering)
    • bugs that can be fixed through other means
  • Low
    • untranslated text strings
    • minor layout bugs
    • feature can be removed from release version if required
  • Very Low
    • minor typos/grammar mistakes
    • broken easter eggs
How do I insert images in my bug report on the issue tracker?

In this page it is explained how to upload images: Issue attachments
It is recommended to use compressed image formats, like .jpg, .gif, .png, and not .bmp.
Locked