Rework ticket template with improved guidelines

LowriJenkins commented 1 month ago

As a developer I would like the ticket templates to be more useful/accurate.

Currently the ticlet templates are not nessecarily clear as to what to put in each section, especially for new starters. The Ticket Templates should have increased guidance on how to fill out each section, amongst other things this should have a section instructing the reviewer how to approach the ticket.

Acceptance Criteria

What is the acceptance criteria?

[ ] Ticket templates contain guidance on how to fill them out.
[ ] Ticket templates contain a section on how the review should be carried out
[ ] Ticket templates should clarify on what to do when information is not nesecary/present (i.e. required files section on a discussion ticket).

Extra Information

Why it is needed? Discussed at retro: https://github.com/ISISComputingGroup/ibex_developers_manual/wiki/Retrospective-Notes-2024.06.19

How to Test

_verbose instructions for reviewer to test changes Check new templates over for acceptence criteria and improved clarity.

Time in planning meeting (18/07/24)

1:29:15

LowriJenkins commented 1 month ago

Could also add the link to the git workflows wiki page to the review section, to make it harder to miss updating submodules.

jackbdoughty commented 1 month ago

See IBEX PR

ISISComputingGroup / IBEX