How to submit "Bugs" and "Features" requests

Github's 'issues' and Wiki pages use a 'syntax' language (not space syntax) for the formatting called: Markdown

So its easier if you have a small free program to help you with the syntax.

http://markdownpad.com/ (Windows)

http://mouapp.com/ (Mac)

**Then remember 5 simple things (for bugs): **

1. Title should describe the exact problem not your agony. Title STARTS with: [BUG]

2. Describe in detail as much as possible so everyone can recreate it on their own machine

In line with the above:

3. Include screen shots with the steps you did in order to recreate the problem, including the error message (in an image and in writing so it is 'text' searchable)

4. Include links to the file that triggers the problem or a file that can trigger the problem if you main file cannot be shared.

5. after you submit you 'issue' email the link with some brief text to the mail lists.

6. **there is no 6, but did you add [BUG] on the title?

In a similar way about "features"

1. Nice detailed title that starts with: [FEATURE] or if its really incomplete you can use [IDEA]

2. Describe in detail as much as possible. Including the theoretical background and the mathematical/algorithmic solution (if you can)

3. Include images or sketches, if possible, that explain your idea.

4. after you submit you 'issue' email the link with some brief text to the mail lists so more people can contribute to your feature or idea!

'Issues' is NOT for asking questions! You need to use the mailing lists for that!