pharo-bug-reports.txt

How do I submit a bug report for Pharo?

Here's how to submit a Pharo bug report.  Fortunately, GitHub makes it easy and 
straightforward.

Start by surfing to https://github.com/pharo-project, then find the particular 
Pharo project that's involved.  In most cases, you'll probably want the "pharo" 
repo: https://github.com/pharo-project/pharo.  (Note that if you enter a bug 
report in the wrong repo, the devs can easily move it to where it belongs.  But 
do try to get the correct one; it will speed things up for everyone.)

Underneath "pharo-project/pharo" you'll see 7 links in a toolbar.  Click on 
"Issues", which brings you to: https://github.com/pharo-project/pharo/issues.

On the right is a big green button, "New issue".  Click that to get a bug entry 
form.  Since you have a bug, click the "Get started" button for "Bug report".

Be sure to choose a good title, carefully worded, to be nice to the devs.  They 
want to get a good idea of what the bug is by just glancing at it.  So keep your 
titles short & sweet.  (50 characters or less it preferred, because your title 
will become an email "Subject:" line; the text below becomes the email body.)

Pharo has a helpful template bug report that tells you what the devs need from 
you.  You can edit it, or replace it entirely with your bug report.  Markdown 
is supported (and can help with readability).  A GitHub markdown "cheat sheet" 
is here: https://guides.github.com/pdfs/markdown-cheatsheet-online.pdf with more 
details here: https://guides.github.com/features/mastering-markdown/.

The toolbar above the text area will apply the most-commonly-used markdown for 
you, with just a button click: Select text, click the associated button.  If 
you don't know how you should format things, read other bug reports to see how 
other, more experienced users are formatting things, e.g., code blocks.

You can click the "Preview" button to see how your markdown will be rendered in 
the submitted report; click on "Write" to return to the editable version you 
started with.

Note that you can attach code, files, images, etc. to help explain the bug you 
found.  You can drag files from your system's file browser into the text area 
of your report and they'll automagically be attached for you.  Similarly, you 
can click where it says, "Attach files by dragging & dropping, selecting or 
pasting them" and it will open a file browser for you to point-and-click.

When you're done, click "Submit new issue".  That's it! 

For more information (including the "official" reporting procedures):
https://pharo.org/contribute-report-bug
https://pharo.org/contribute-propose-fix
https://github.com/pharo-project/pharo/wiki/Contribute-a-fix-to-Pharo
https://github.com/pharo-open-documentation/pharo-wiki/blob/master/CONTRIBUTION.md