How to report a bug

This document tells how and where to report bugs. We use an online issue tracker for that, see https://github.com/epicmonkey/pepyatka/issues

If you are about to report a bug, please first, make sure it is a bug. Once you have established that it is a bug, the most important thing you can do is come up with a simple description and reproduction recipe. For example, if the bug, as you initially found it, involves ten subscription requests, try to make it happen with just one subscription request. The simpler the reproduction recipe, the more likely a developer is to successfully reproduce the bug and fix it.

In addition to the reproduction recipe, we will also need a complete description of the environment in which you reproduced bug like your browser and version of it.

Once you have all this, you are ready to write the report. Start out with a clear description of what the bug is. That is, say how you expected Pepyatka to behave, and contrast that with how it actually behaved. While the bug may seem obvious to you, it may not be so obvious to someone else, so it is best to avoid guessing game.

Follow that with the environment description, and the reproduction recipe. If you want also to include speculation as to the cause, and even a patch or pull request to fix bug, that is great! See How to contribute page for more information about contribution.