Bug Report

---
description: "Filing Bug Tickets Description"
icon: "Sample"
layout: "guide"
title: "Filing Bug Tickets"
weight: 2
---
# Filing Bug Tickets

Follow these steps if you found a bug in Liferay.

1. Search JIRA to make sure a ticket has not yet been opened for the issue
	1. If you find a ticket, leave a comment saying you reproduced the issue on your environment
2. File a bug ticket
	1. Click on the `Create` button in JIRA
	1. Select `Public - Liferay Portal Community Edition` as the project
	1. Select either a `Bug` or `Regression Bug` as the issue type. See [this workflow diagram](../images/bug-vs-regression.PNG) for more details
	1. Click `Next`

	![alt text](../images/lps-ticket.PNG)

	1. **Summary** - Write a succinct summary of the bug (e.g. Image Editor cannot be loaded, Console errors appear after publishing Blogs post)
	1. **Component** - Select the Component where the bug was found
	1. **Bug Type** - Leave as none
	1. **Security Level** - Leave this blank
	1. **Affect Version** - Select what versions of Portal are affected by this bug
	1. **Description** - Write out the steps to reproduce and the environment you reproduced on using the following format:

	```
	Steps to reproduce:
	1. Step 1
	2. Step 2
	...
	X. Step X

	Expected result:
	[Write a short sentence here describing what should have happened in Portal after executing step X]

	Actual result:
	[Write a short sentence here describing what actually happened in Portal after executing step X]

	Reproduced on:
	[App Server] + [Database].
	Portal [Branch version] GIT ID: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
	```

	**Note:** The more descriptive a ticket is, the easier it will be for others to understand the issue you are describing. Take screenshots, gifs, videos, etc. liberally.

	![alt text](../images/lps-ticket-description.PNG)

	1. Click `Create`

You can apply [labels to tickets](../../../../references/pages/JIRA-labels.markdown) after they are created.

# Verifying Bug Tickets

Once a bug ticket is filed, it will only be worked on by a developer if it is first verified. All bug tickets by default are created with the status `Open`. It is the job of the test engineer to verify these tickets. If you are verifying a ticket that was not created by you, follow the steps in the ticket description to reproduce the issue. If you can confirm that the issue exists, verify the ticket.

To verify a ticket:
1. Click the `Verify` button
1. Assign a fix priority to the issue using the [Portal Risk Assessment Matrix](https://docs.google.com/spreadsheets/d/1AEKD3C7WhkwWffJiCdNul5MBt-9Rl_fa0WPQVSkYptY)
1. Leave a comment in the ticket explaining how you determined the fix priority (e.g. `L3 + S4 = 4FP`)
1. Restrict comments to `liferay-staff`

![alt text](../images/fix-priority.PNG)

# Closing Bug Tickets

Once a bug ticket is resolved, it is your job to test and make sure the bug is fixed in the source code. You will then close out the issue.

To close out a ticket:
1. Click the `Close Issue` button
1. Make sure there is a Fix Resolution selected
1. Make sure there is a Fix Version specified
1. In the comment section, include the result of your testing and relevant details (see examples below)
1. Click `Close Issue`

Example 1 (Pass, description contains steps to reproduce):
```
PASSED Manual Testing following the steps in the description.

Fixed on:
Tomcat 9.0.6 + MySQL 5.6. Portal master GIT ID: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.
```
Example 2 (Fail, description does not contain steps to reproduce):
```
FAILED Manual Testing using the following steps:

# Lorem ipsum dolor sit amet, consectetur adipiscing elit.
# Suspendisse nec quam vitae elit luctus venenatis ac vitae nunc.
# In quis urna eu magna porta venenatis non a elit.

Failed on:
Tomcat 9.0.6 + MySQL 5.6. Portal master GIT ID: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.
```
Example 3 (No Longer Reproducible, description contains steps to reproduce):
```
No Longer Reproducible through Manual Testing following the steps in the description.

No Longer Reproducible on:
Tomcat 9.0.6 + MySQL 5.6. Portal master GIT ID: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.
```