From 73de3b3897a9715d7e45623b754fa564d08d153d Mon Sep 17 00:00:00 2001 From: rnovikovP Date: Mon, 19 Jun 2017 17:10:31 +0300 Subject: [PATCH] Update Readme added Submitting Bug Reports --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 2227d884..60c3890d 100644 --- a/README.md +++ b/README.md @@ -25,3 +25,24 @@ Setup development environment. python -m SimpleHTTPServer 8000 ``` 1. SPA should be accessible on http://localhost:8000/ + +## Submitting Bug Reports + +If you find a bug in Percona QAN App or one of the related projects, you should submit a report to that project's [JIRA](https://jira.percona.com) issue tracker. + +Your first step should be [to search](https://jira.percona.com/issues/?jql=project+%3D+PMM+AND+component+%3D+%22QAN+App%22) the existing set of open tickets for a similar report. If you find that someone else has already reported your problem, then you can upvote that report to increase its visibility. + +If there is no existing report, submit a report following these steps: + +1. [Sign in to Percona JIRA.](https://jira.percona.com/login.jsp) You will need to create an account if you do not have one. +2. [Go to the Create Issue screen and select the relevant project.](https://jira.percona.com/secure/CreateIssueDetails!init.jspa?pid=11600&issuetype=1&priority=3&components=11306) +3. Fill in the fields of Summary, Description, Steps To Reproduce, and Affects Version to the best you can. If the bug corresponds to a crash, attach the stack trace from the logs. + +An excellent resource is [Elika Etemad's article on filing good bug reports.](http://fantasai.inkedblade.net/style/talks/filing-good-bugs/). + +As a general rule of thumb, please try to create bug reports that are: + +- *Reproducible.* Include steps to reproduce the problem. +- *Specific.* Include as much detail as possible: which version, what environment, etc. +- *Unique.* Do not duplicate existing tickets. +- *Scoped to a Single Bug.* One bug per report.