Skip to content
Christopher Baker edited this page May 23, 2017 · 13 revisions

Pre-made responses for issues

This list has been adapted from the list of Ubuntu canned responses. It may help you save time when dealing with issue reports.

Old Bug

This bug is quite old. Is this issue still relevant in the current version of OF?

Not described well

Thank you for taking the time to report this bug and helping to make openFrameworks better. Unfortunately, we cannot work on this bug because your description didn't include enough information. You may find it helpful to read "How to report bugs effectively" http://www.chiark.greenend.org.uk/~sgtatham/bugs.html. We'd be grateful if you would then provide a more complete description of the problem.

At a minimum, we need:

  1. the specific steps or actions you took that caused you to encounter the problem,
  2. the behavior you expected, and
  3. the behavior you actually encountered (in as much detail as possible).
  4. Platform (Mac/Windows/Linux/etc..) and version of Operating System

Thanks!

Missing Steps to Recreate Bug

Thank you for taking the time to report this bug and helping to make openFrameworks better. Please answer these questions:

  • Is this reproducible?
  • If so, what specific steps should we take to recreate this bug?

This will help us to find and resolve the problem.

Reporter uses outdated version

Thank you for taking the time to report this bug and helping to make openFrameworks better. However, according to this report, you are not using the most recent version of openFrameworks. Please upgrade to the most recent version and let us know if you are still having this issue. Thanks in advance.

Old untouched bugs

Old new bugs that haven't been touched in a quite a while and you are unable to recreate the bug.

Thank you for taking the time to report this bug and helping to make openFrameworks better. We are sorry that we do not always have the capacity to look at all reported bugs in a timely manner. There have been many changes in openFrameworks since that time you reported the bug and your problem may have been fixed with some of the updates. It would help us a lot if you could test it on the current version of openFrameworks. Please report back or close this bug when you have tested it.

Fixed in master while still existing in a previous release

Thank you for taking the time to report this bug and helping to make openFrameworks better. However, this is being closed because the bug has been fixed in the latest development version of openFrameworks. You can either wait for the next release or work with the develop branch.

Bug is a duplicate

Thanks for the bug report. This particular bug has already been reported into our bug tracking system, but please feel free to report any further bugs you find.

Thanks for taking the time to report this bug. This particular bug has already been reported into our bug tracking system, but the maintainers need more information to fix the bug. Could you please answer the questions in the other report in order to help the developers?

PR is malformed

Thanks for taking the time to make your pull request. Unfortunately, your pull request is not configured correctly. Please make sure that

  1. the PR target is master: On top it should say

<username> wants someone to merge <N> commits into openframeworks:master from <username>:PR-branch

  1. the PR contains only the changes you want merged. Check the "Commits" and "Diff" tabs for unintended changes, like project files, OS-specific files like thumbnails, etc.

  2. the PR contains (typically) only changes in connection with one bug/feature. If you have several different things you want merged, separate them into different PRs.

More detailed information on how to contribute can be found in the section How to contribute on the wiki page openFrameworks git workflow

Changelog entry is missing

Thanks for taking the time to make your pull request. All pull requests that contain changes that need to be in the changelog must include edits to CHANGELOG.md. This will help us avoid the changelog preparation bottleneck that always happens before a release. Use previous entries as a guide for style/indentation/etc.

Please send us your code contribution

Do you have a patch and/or fix you can offer to OF? If yes, please either find an existing issue which fits the subject of the fix, or open a new issue at https://github.com/openframeworks/openFrameworks/issues/. Then, please submit a pull request with your changes. More infos regarding the proper workflow at https://github.com/openframeworks/openFrameworks/wiki/openFrameworks-git-workflow -> How to contribute

Respond with poetry

You could also respond with something a bit more poetic, if you're so inclined. :-P For example, this limerick is courtesy of @thiagohersan:

claiming his code would go faster
and avoid certain runtime disaster
he forked and compared
a pull was prepared
but, doh... he did it against master