Learn how to use issues in the Plan section of the Codebots platform.
The following content is continued on from the article Using Plan
Issues represent the pieces of work which the team are working on. They may be design tickets, tech spikes, dev tasks, anything you want to track. Issues have a summary and description, along with various checklists and commenting.
Creating an issue
Depending on where you are in Plan, there are different ways you can make a new issue.
- If you are in the backlog, Using the backlog in Plan.
- If you are in a board, Using statuses in Plan and learn how to create an issue in a status.
Changing an issue’s status
There are two ways you can change an issues status. The first is to change it from the issue detail view (opened by clicking on the ticket). The status can be changed using the dropdown right at the top, underneath the ticket title.
Drag and Drop
The other option is to use the drag and drop functionality to shift an issue between the status columns. This is also an excellent way to re-order your tickets if you want to keep highest priority issues at the top.
- Move your cursor to hover on top of the ticket. Your cursor should change to the grab symbol at this point.
- Click and hold your mouse, then start moving it around.
- At this point, the ticket will move with your mouse.
- You will be able to see a grey box indicating where the ticket will be dropped.
- Still holding down the mouse, move your cursor over to the status you want the issue to move to (ensuring the box is there) then release your hold.
- At this point the board will reshuffle to make room for your ticket in the new column.
Updating an issue
To change the details about an issue, you will need to open the issue’s detail view. From the board view, this is done by clicking on the issue. Once the modal has opened, you have a variety of options around what you can change.
Changing the Description
The most prominent field you will work within is the description. The description uses a markdown editor so you can format your text and include things like tables. (Not familiar with markdown? Markdown Basics. Your changes will be saved when you click away from the field.
Commenting on an Issue
Comments are a fantastic way of discussing a ticket with your team. It means that you can keep all of the knowledge in one place. To view and add comments, change from the ‘Details’ tab to the ‘Comments’ tab. There you can see all of the comments which have been made and write your own.
You can either comment on the ticket directly, or continue a conversation by replying to someone else’s comment.
Status Checklists in an issue
If you have Using statuses in Plan, and your issue is currently in that status, then a second checklist will appear on your ticket’s details. You can check off the different items in this list for the currently selected ticket.
If the ticket moves out of the status, the checklist will change, but if it then gets moved back it will still have the same items selected.
Issue acceptance criteria
Acceptance criteria are a fantastic tool to ensure that the work your team does actually does everything which is expected. For more information about acceptance criteria, Acceptance Criteria. Using Plan, you can define the acceptance criteria against each ticket and it will show as a checklist at the bottom of the ticket.
To create checklist items, scroll down to the Acceptance Criteria heading. You will see a ‘+ New item’ input underneath. Click on this to select it, then start writing in the name of your first item. Hit the enter key to submit your item, and it will appear as an item in the checklist. You can keep creating new items until your checklist is done.
To mark an item as done, all you need to do is click on the checkbox associated with it, and the progress bar will update. You can remove items from the list by clicking on the ‘X’ button on the right of the item.
Removing an issue
Archiving an issue
When you have finished with a ticket and you no longer want it in your main view, you can archive it. This does not delete the ticket, but rather just keeps a copy of it which you can revive at anytime.
To archive a ticket, open the ticket’s detail view. Right at the top of the model, you will see a button to open the options menu, denoted by three stacked dots. Click on this to open the menu, then select the archive option.
Once an issue has been archived, you can view it by switching over to the archived board view. To do this, simply click on the ‘View archived issues’ button in the bottom-right of the header. If you want to unarchive the issue, open its detail view, click on the button to open the option menu, then select the archiving option. Once you have done this, you will need to switch the board back to normal mode to see the unarchived ticket.
Deleting an issue
If you want to permanently remove an issue from your board, you can delete it. Be careful though, once it has been deleted there is no way to recover it.
To delete a ticket, locate it on the board and open its detail view. Find the option menu in the header (denoted by the stacked dots), and select the ‘Delete’ option from the list. Confirm you want to continue, and it will be removed.
Moving an issue to a different board or the backlog
If you find yourself with the need to move your issue out of the current board, it is quite simple. All you need to do is locate your issue on your board, then click on the move menu in the top-right corner of the “ticket”. It will give you the option to move the issue to the top, the bottom, the backlog, or to any other boards.
Currently, when you move a ticket to another board or the backlog, they do not retain their status. If sent to another board, they will be dropped at the bottom of the left-most column.
Last updated: 15 August 2020