Skip to content

Defects Processing Procedure

Jump to bottom
NatalliaAlieva edited this page Feb 13, 2024 · 1 revision

Introduction

UUI is an open sourcing project, so anyone can contribute to its development. One way to contribute is to document the error found.

A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report.

Please complete the following steps in advance to help us fix any potential bug as fast as possible.

  • Make sure that you are using the latest version;
  • Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the Documentation. If you are looking for support, you might want to check This Section);
  • To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the issues.

General Rules for Bug Reporting

  • We use GitHub Issues to track bugs and errors; 
  • All defects should be created with label bug. If you use the default bug template, this label will be set automatically;
  • All bugs are considered with minor priority by default, and will be taken to work in order of priority. If you think your bug is higher level, add the medium or major priority to the ticket. How to add such labels you can find in the instructions below;
  • A clear and descriptive title for the issue to identify the bug. Please put the component name in square brackets, e.g. [PickerInput];
  • A quick summary and/or background (optional);
  • Steps to reproduce:
    • Don’t make generic statements. Be specific on the steps to follow;
    • Give sample code if you can. You can use our UUI Codesandbox template for it;
  • Actual result. What actually happens;
  • Expected result. What you expected would happen;
  • Attachments:
    • You can add a screenshot, video or animated GIFs of the instance of failure;
    • Screenshots should be done with URL seen (even if you want to show only a little button - make 2 screenshots, first with button and second with the whole page);
    • Highlight unexpected error messages with a noticeable color. This draws attention to the required area;
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work).

How to Submit a Bug

  1. Open UUI in GitHub.

  2. Go to Issues tab.

  3. Click on New issue button. image

  4. Click on Get started button in the Bug report line. This button opens default bug report template. image

  5. If you want to create your owner bug template you can return on the previous page and click on Open a blank issue. image

How to Add Additional Label

You can add additional labels both during the creation of the bug and after it has been saved. The principle of adding a label is the same in both cases. 

  1. In the "Labels" section on the right side of the page, click on the gear icon. image

  2. In the drop-down list that appears, select the label you want to add and click on it. You can use the search. image

How to Set Task Priority 

  1. To set the priority, open the saved task.

  2. Find "Projects" section on the right image

  3. Click on the dropdown on the right image

  4. Click on the dropdown with priorities and choose the one that suits you image

Examples of Good Bug Reports

Example #1

Example #2

Clone this wiki locally