How to raise an issue for a Bug (when something is not working as expected)
- Dominant language
- No language data
- Stars
- 44
- Forks
- 3
- PR merge metrics
- No merged PRs in 30d
Description
We have an [**issues**](https://github.com/dwyl/github-reference/blob/8e64a9317556438b03875a98e38c9a44c47b406f/README.md#issues) section in the readme but it does not cover how to raise an issue when there is a (_suspected_) Bug.
Specifically, we should have a _checklist_ similar to @SimonLab's https://github.com/SimonLab/user-story-checklist ...
> _Specifically_ we need to _educate_ (_non-technical_) people to include as _much_ information as possible in the issue description for two important reasons:
> - (A) it helps the team/developer understand _precisely_ what is not working as expected, so she can write the appropriate **_regression test**_ (to prevent the "bug" from re-appearing after it has been "fixed") and write a fix that _exactly_ fulfils the expectations.
> - (B) it helps the (QA) person checking to see if the bug has indeed been fixed sign off.
### Screenshots!
Where ever possible, upload a screenshot of the issue (_if it is a visual one_) so we can see _exactly_ what is wrong. If you have an image editor (e.g: Paint) draw a box around the issue.
> _How_ to **take screenshot**: http://www.take-a-screenshot.org/ (**_all platforms**_!)
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.