Secret ingredients to quality software

GitHub Issues - Do you use Issue Templates?

Last updated by Brady Stroud [SSW] on 10 Nov 2021 11:48 pm (7 months ago) See History

GitHub Issues offer a great way of raising Issues within projects. However, it can be difficult to distinguish whether the Issue is a bug, feature request or just a question. GitHub Issue Templates should be used to help standardize Issues and ensure they have enough information for a developer to start work.

Let's take a look at how implementing Issue Templates can improve repository backlogs...

bad example issue
Figure: Bad Example - Issue created without a Template

good example issue
Figure: Good Example - Issue created from a Template

list of options
Figure: Good Example - All the available Issue Template

For instructions on setting this up:

Tom BuiTom Bui
Brady StroudBrady Stroud
Adam CoganAdam Cogan
Piers SinclairPiers Sinclair
Luke ParkerLuke Parker

We open source. Powered by GitHub