Issues Templates - SE750-Group14-GirlGang/roadtrip-planner GitHub Wiki
What to Include
Issue templates have already been created that provide the necessary issue headings. This section is just for reference.
Enhancement (An issue for a new feature)
Title: [A brief description of the issue's goal]
Example: Create a logout button
User Story: [Describe the user need that is being solved by completing this issue]
Example: As a user, I want to be able to logout of the application.
Acceptance Criteria: [A bullet point list to describe what must be included in this new feature]
Example:
- A logout button on the Roadtrip top bar and dashboad top bar
- When clicked, the user is logged out of Auth0
- The component is created with Material UI and uses a logout icon
Additional Context: [Any other useful information. e.g. design screenshots, any work previously done]
Dependencies: [If applicable, links to other issues that this issue is dependent on]
Labels
enchancement, frontend OR backend
Bug (An issue for reporting a bug)
Title: [A brief description of the bug]
Describe the bug: [Describe the bug in, if necessary, more detail than the title]
Steps to reproduce: [Bullet point steps for someone to follow to observe the bug]
Screenshots: [Screenshots/screen recordings of the bug]
Expected behaviour: [What do you expect to see]
How to fix: [If you know how to fix it, say so]
Additional information: [If applicable]
Labels
bug, frontend OR backend
Setup (An issue for changes that aid development)
Title: [A brief description of the issue's goal]
Example: Add material UI icons as a dependency
Developer Story: [Describe the developer need that is being solved by completing this issue]
Example: As a developer, I want material UI icons to be a dependency so I can use the icons.
Acceptance Criteria: [A bullet point list to describe what must be done]
Example:
- Material UI is added to the package.json
Additional Context: [Any other useful information]
Dependencies: [If applicable, links to other issues that this issue is dependent on]