Work with bugs in an AWS BugBust event (admin and player)

On an AWS BugBust event page, you can view the event's bugs, see how many are claimed and unclaimed, and see how many are fixed. On an event page, players can also claim bugs to work on. A player can claim up to ten bugs at a time. For information about how many points are awarded for fixing a bug, see Scoring with Amazon CodeGuru Reviewer bug fixes.

Find bugs in an AWS BugBust event (admin and player)

You can view your event's bugs on its event page. Your event page has bugs if the AWS BugBust event administrator imported bugs for players to work on. For more information, see Import bugs from CodeGuru Reviewer code analyses.

View an event's imported bugs

1. If you are not on your event details page, follow the appropriate steps in View AWS BugBust event information (admin and player) to open it.

2. Choose Bugs.

An event can have many more bugs than can appear in the event console page at a time. Enter a term in Find bugs to find a bug you want to claim and fix. You can search on the following properties.

• Repository – The name of the repository that contains the code in which a bug is found.

• Branch – The branch in a repository that contains the code in which a bug is found.

• Path – The path of the file that contains the code in which a bug is found.

• Status – The status of the bug, which is claimed, unclaimed, or fixed.

• Category – The category of the bug, which determines how many points it's worth. For the list of categories, see Scoring with Amazon CodeGuru Reviewer bug fixes.

• Points – The number of points awarded when a bug is fixed. The valid scores are 5, 3, and 1. For more information, see Scoring with Amazon CodeGuru Reviewer bug fixes.

You can also sort the bugs by how many points they are worth.

Setting the status of a bug (admin)

You can set the status of a bug to unclaimed, fixed, or false positive. If you set the status of a bug to unclaimed, then any player can claim that bug to fix. After a bug is marked false positive or fixed, its status cannot be updated again.

A false positive bug is a bug found by Amazon CodeGuru Reviewer that isn't actually a bug. Because CodeGuru Reviewer uses machine learning to detect bugs, on rare occasions it detects a bug that doesn't exist in clean code.

To override the review process, set the status of a bug to fixed. This automatically assigns the player the number of points that corresponds with the bug's category and bypasses the process to submit its fix. For more information, see Submit a bug fix (player).

Change the status of a bug

1. If you are not on your event details page, follow the appropriate steps in View AWS BugBust event information (admin and player) to open it.

2. Choose Bugs.

3. Select a bug. For information about finding a specific type of bug, see Find bugs in an AWS BugBust event (admin and player).

4. From the Mark as dropdown list, choose Mark as unclaimed, Mark as fixed or Mark as false-positive.

Claim or unclaim a bug (player)

You must claim a bug before you start working on fixing it. When you claim a bug, no one else can claim the bug. If the code you submit doesn't actually fix the bug, then the status of the bug returns to unclaimed for any player in your event to claim. You can claim up to ten bugs at a time To earn points, you must fix and then submit a claimed bug before your event ends. For more information, see Submit a bug fix (player).

Claim or unclaim a bug

1. If you are not on your event details page, follow the appropriate steps in View AWS BugBust event information (admin and player) to open it.

2. Choose Bugs.

3. Select a bug. For information about finding a specific type of bug, see Find bugs in an AWS BugBust event (admin and player).

   1. Choose Claim to claim a bug. You can only claim bugs with a status of unclaimed.

   2. Choose Unclaim to unclaim a bug. You can only unclaim bugs that are claimed by you.

Submit a bug fix (player)

After you are done fixing your bug, submit it to earn points for your bug fix. Do the following to submit your bug.

• Create a pull request to submit the code with your bug fix. The pull request initiates a new Amazon CodeGuru Reviewer code review.

• Merge your code into its branch.

If the bug you fixed is not found during the code review, then you are assigned the number of points associated with your bug's category.

If the code review determines your submitted code did not fix the bug, then the bug continues to be claimed by you until you fix or unclaim it. You can attempt to fix the same bug multiple times until a code review no longer detects it. For each attempted fix, create a new pull request and merge your code to submit it again. When the bug is no longer detected, you earn points. For more information, see Rules and scoring in AWS BugBust.

Important

If the email you use for the commit that creates the pull request to submit a bug fix is not added as an authorized email in your AWS BugBust player portal, you cannot score points. To learn how to add additional authorized email addresses, see Adding authorized email addresses in the AWS BugBust player portal

View bug fix pull requests (player)

After you submit a bug fix, you can view the pull request you used to check in the code. All your pull request appear in the same place.

Your pull requests appear with their status. A pull request can have one of six statuses.

• Analyzing – An analyzing pull request has been recently submitted and Amazon CodeGuru Reviewer is analyzing the updated code.

• Error – An error pull request is in an error state.

• No fix detected – CodeGuru Reviewer has analyzed a no fix detected pull request and found the bug you attempted to fix. You do not earn points when the bug was not fixed. You can continue to try fixing the bug by submitting an updated bug fix with a new pull request.

• Waiting for merge – CodeGuru Reviewer has analyzed a waiting for merge pull request and it did not find the bug you attempted to fix. This means your bug fix succeeded. You must merge the code of pull requests in this state in order to earn points for the bug fix.

• Merging – A merging pull request is merging. A pull request enters this state after the code merge into its branch is initiated.

• Success – A success pull request is merged. The code in the pull request fixed the bug and points for the bug have been assigned to you.

View your pull requests

1. If you are not on your event details page, follow the appropriate steps in View AWS BugBust event information (admin and player) to open it.

2. Choose Bugs.

3. Choose My pull requests.

Important

If you created a pull request for a bug fix and don't see it in your event, try the following.

• Make sure the email you used to create your pull request is added as an authorized email to your AWS BugBust account. For more information, see Adding authorized email addresses in the AWS BugBust player portal.

• Make sure the email you use to create your pull request is public, not private. Refer to your repository vendor's documentation to learn how to verify this.

If you see your pull request, but have not received points for fixing the bug, make sure you have merged the request. To earn points for a bug fix, you must create a pull request and merge it into your branch.