Gitlab practices part 1
How to report a issue as ticket
Notes#
Optional notes about the guide
This is guide how we should work according process
Introduction#
- How to report a bug/incidents as Gitlab Issue
- How developer should fix the bug?
- How to report steps
Prerequisites#
- You have found a incident/Bug
- You would like to report this as issue
What do you expect the reader to know or have done already?
1. Reporting Incident/Bug#
1.1 Create a new issue#
Go to Work queue's issue tracker. Before creating new issue, check the issue tracker in case someone has already reported the same bug. Duplicate issues can slow down development and make bug fixing more difficult. If you find an already existing issue describing the same bug, join the discussion by commenting that you have also encountered it. If you believe that you have possibly found a new bug, create a new issue by clicking "New issue" button.
1.2 Give the issue a title.#
Give your bug report short, but descriptive title. Avoid vague titles such as "X feature is broken". Instead, summarize the issue in one short sentence. For example "X feature is not being triggered on first-time user experience".
1.3 Choose the bug report template#
Under “Description”, click “Choose a template” and select “bug” from the project templates.
1.4 Fill out the template#
Summary#
Give a short, concise summary of the bug. Also, provide relevant information about your environment. For example, the device you are using, what operating system you have, and which browser you are using.
Steps to reproduce#
Give an accurate, step-by-step description on how the developer can reproduce the bug.
What is the current bug behavior?#
Describe what the bug is actually doing and how it deviates from the expected result. Being specific here is the most helpful for the developer, so mention exact behaviors, error messages, or UI inconsistencies. More details make it easier for developers to investigate.
What is the expected correct behavior?#
Explain what should happen instead. Describe the ideal end-user scenario as clearly as possible.
Relevant logs and/or screenshots#
Please provide any screenshots, screen recordings or console error logs. Visual evidence makes it much easier to understand and verify the problem.
Possible fixes#
If you have an idea what might be causing the bug, feel free to suggest possible solution or direction for developer to explore.
TODO: add screenshot of example bug report
2. Fixing Incident/Bug in source code repository#
3. Commiting fix to branch#
4. Adding Regression test for fix#
- (Error based testing)
The main content of the guide and instructions goes here