Skip to content

GitHub Issues/Tickets

GitHub Logo

This GitHub project repository serves as a project planning and progress tracking platform for the development teams and clients. This repository is public and for anyone to view. The repository can be accessed here.

Tickets

Tickets on the SAEOSS-Portal GitHub Project Board are created first as issues and converted into tickets to work on during the sprint at the SAEOSS-Portal catch-up meeting. This workflow ensures work required by the client gets done as well as allows the opportunity to clear up any doubts regarding work that needs to be done. When issues are created, a clear description of what needs to happen is required as well as any accompanying screenshots or videos. If a developer has any doubt, they can simply comment on the ticket, and the creator of the ticket, as well as any assigned developers, will be notified via email.

Creating new Github issues/tickets

When encountering a new issue with the platform, it is best practice to create an issue or ticket on the SAEOSS-Portal GitHub Issues Page. This ensures developers are made aware of the issue at hand and can work to get the problem fixed as soon as possible.

Templates

A standard workflow for creating tickets is advised to make sure enough information about the problem is related, cutting down on time developers would spend trying to understand the issue at hand.

To ensure this, a general approach has been created to make sure users are able to create a GitHub ticket with as much detail as possible. The following template can be copied and used to create a new ticket.

Template

🚩 GitHub supports various forms of media, including: Markdown syntax, images, and video. All of these can be used to better and more accurately describe your issue. Read more

Workflow for creating GitHub issues

To report an issue, users should first access the SAEOSS-Portal Project Page. Ensure you are logged in to GitHub, as users who do not have a GitHub account will not be able to create new issues. If you do not have a GitHub account you can create a free account.

ProjectBoard

  1. From the navigation pane select Issues to display all the current GitHub issue tickets. Nav Make sure to study the issues page to determine if the issue has been reported by another user before creating a new issue. Nav

  2. If the issue has not been reported, select the create new button. NewIssue

  3. Copy the template and complete the template while taking care to provide as much detail as possible. Remember to add a descriptive title and screenshots. ProjectBoard

  4. Preview the ticket by selecting the preview tab. This will generate the ticket from markdown syntax (if used) and will also display images, giving you a view of what the completed ticket will look like. ProjectBoard

  5. When satisfied, select submit from the green button at the bottom. Your issue has now been created and will appear at the top of the issues with a "#" number assigned to it.