A layman's guide - How to create a JIRA Issue

From ReactOS Wiki
Jump to: navigation, search

Index to the layman's guides

Important: Please make sure that the bug can be reproduced and that it is not just a 'one off'. If it cannot be reproduced by others, then the Issue may be closed as 'Cannot Reproduce' .

Requirements for a good and useful report:

1. Get a debug log

This is vital (see A layman's guide - How to get a debug log). Always get one, unless the failure happens before any output occurs. Remember that there are three ways to get debug info, by running ReactOS in either Debug, Screen or Log file

2. The Revision number

Always include the ReactOS revision number in your report. The revision number can be found in the bottom right hand side of the desktop. You can also get it from the ISO file (tip: right click the ISO file and select Rename, then copy the highlighted file name, then click somewhere else, to get out of the file Rename).

3. Virtual machine or real hardware

If using a virtual machine, state which VM with it's revision number and if you installed Guest Additions. If running in real hardware, give it's specification or a link to it.

4. What file system

State the file system that ReactOS is installed on, eg. fat32, Btrfs, EXT2/3/4, etc.

5. Describe what you were doing

Describe what you were doing, what happened and in clear steps, how to replicate the bug so that others can reproduce the same bug.

6. Links to software

If the bug occurred in software that was not included in the ISO, then please give a link to the exact revision of the software that you used.

Where and how to make a bug report

Links to the Jira page.

From the ReactOS.org front page, you go to the JIRA page (https://jira.reactos.org/) by clicking on the DEVELOPMENT link on the top banner, then in the drop-down list, the Jira link. If you successfully followed the link you should now be at the Dashboard page of ReactOS JIRA, on the right side of the page [1], you should see a login form (there is also a login link in the top right of the page, which will open another page with a log in form), just use your forum username and password. After logging in, the page does not show the Activity Stream and other boxes; just refresh the page.

Note: If you have only just created an account for the forum, you may find that you cannot log into JIRA, if that as happened to you, you will have to wait a few hours and try again (it takes time for your login details (user name, password) to get to all the places it is needed).

When you have logged in, the next thing to do, is a search to see if your bug issue has been reported already. Use the Search box at the far right of the navigation bar at the top of the page [1] or on the Issues link on the navigation bar [2].

Click the Search for issues, which will take you to the Search [3] window.

You need to put your search word(s) in the box Contains text and press Enter on your keyboard. The list in the side window will update and the first result will be highlighted and the report will be shown in the main window. You can scroll down the list in the side window, by using the down arrow key on your keyboard; the main window will then update with the report which is highlighted in the side window. If you think a reported issue matches the bug issue you wish to report, then, if you think that you can add further information which could be helpful, then use the Comment button [10] at the bottom of all the Comments, which opens the Comment editor [11]. When you have made your comment, click on the Add at the bottom right of the editor window.

If you did not find anything that could be the same bug as yours, then you will have to create your own bug Issue report.

Don't be intimidated by JIRA, it is very simple to create an issue! You will need to be logged into JIRA and you will see a nice blue Create Issue button to click, at the top of the page on the navigation bar [4], which will open a Create Issue form [5], when the form appears, there are just 2 input boxes to fill in (leave the others alone).

Give a short description of the problem in Summary (this will be the title of the report).

In Description, state if you were testing in real hardware (list your computer specification), or in a virtual machine (state what VM you use), then the revision number of ReactOS that you are using, state the file system that ReactOS is installed on, (if the problem involves additional software, then include the down-load link to that software), then describe what happens and how to replicate the problem. Here https://jira.reactos.org/browse/CORE-12843 is a good report to give you some ideas on how to make a helpful report, which will help the developers find and fix the problem.

If you get a debug log or take a photo or video, use the Browse link in Attachment or drag and drop files into the Attachment to upload it.

That is all you need to fill in, leave the rest to the developers. To submit your report, click on the Create button in the bottom right of the form.

Adding more debug logs, photos and videos.

Having created a JIRA Issue for your bug, you have a need to add another debug log, photo or video.

Go to ReatOS JIRA and log in. Then go to the Issues [6] button and select Reported by Me [7] and your Issues will be shown.

Find your report and then scroll down the side window and select the Issue you want to add more files to. Then use either the More tab, then in the drop down list, click the Attach files link [9].

Or further down at Attachments, you can use the Browse link or drag and drop files into Attachments to upload it [9]. In the Comment box you can describe the attached file(s) and any further information about the Issue you wish to add, then use the Attach button at the bottom of the form, to attach it all to the report.

If you only want to add more information, or to reply to a question from a developer, use the Comment button [10] at the bottom left of the page, which will open a Comment form. When you have finished writing in the Comment form, use the Add buttom [11] to attach it to the report.

When you first created your bug issue report, you may have chosen the wrong words for the Summary (the summary becomes the title of the report) and you now want to change them for some that better describe your bug. In the Reported by me Issues window [8], move your mouse pointer over the title and a pencil will appear at the end [12], click on it and a cursor will appear in the title, so that you can edit the it. , When you have finished editing the title, press Enter on your keyboard.

* You are strongly advised to follow the instructions here in the main text and not to go altering things like Priority, Component/s or Fixed Version/s, which are accessible from the Edit button [9]. Please do not upset the developers by altering things that you do not fully understand! You may think that a bug is a Blocker or Critical, but the developers may think that it is only Minor or Trivial.

If you read JIRA Dashboard commits, and see something that you can usefully comment on, then you can make a comment by clicking on Comment at the bottom of the commit, which will open a drop down form [13], where you can make your comments. When you have finished, just click on the Add button.

Please Note: Jira is not a forum, so when adding comments to your own or other peoples reports, ask yourself 'does this add value to the report', 'is it going to be helpful'; if it does not, then do not make the post. Please do not make trivial or silly comments, it is better to click Cancel than to fill JIRA with rubbish comments. So make sure that what you have typed will help others, before you activate the Add button.

Index to the layman's guides