World map

 

BM

World 5: Teamwork

Issue templates, sub-issues and types

You will learn: how templates, sub-issues and issue types keep issues clear.

The problem

Sam’s new issue just says “it doesn’t work”. Which page? Which phone? Ask Sam one kind question.

Practice repo — not a real website
kelab-kod / club-site
it doesnt work #17
Open #17 opened by sam
Labels
None yet
  1. sam

    it doesnt work

Watch

An issue template: A ready-made form with blanks, so every new issue gives the details you need. is a form with blanks. It lives in .github/ISSUE_TEMPLATE/. Every new bug report starts with these questions.

Try it

Help Sam. Fill in the template for the bug: the sign-up button does nothing.

Fill all three blanks.

Preview

What happened?

Steps to see it

Phone or computer?

0 of 3 goals done

Predict

The events page is a big job. Aina splits it into 4 sub-issue: A small issue inside a bigger one. The big issue shows how many are done.. 2 are closed. What does the big issue show?

Try it

Organizations can give each issue a issue type: The kind of work an issue is, like Bug, Feature or Task. Organizations set these up.. The starting types are Bug, Feature and Task. Sort these issues.

Drag a card into a box. Or tap the card, then tap the box.

        Check

        Good way to organise issues, or needs work? Swipe each one.

        Swipe right for good, left for needs work. Or use the buttons.

        1 / 4

        Split "Build the events page" into small sub-issues

        You did it!

        You can now keep issues clear with templates, sub-issues and types.

        Go deeper (optional)

        Templates can also be issue forms: .yml files with real form fields. A config.yml in the same folder sets up the template chooser. A pull request template (pull_request_template.md) fills new PR descriptions. Sub-issues can have their own sub-issues. Issue types are set up in an organization’s settings.