Working with Waffle.io

Waffle automation does the following things for us:

• it moves issues into In Progress when you push your working branch (provided the branch name includes the issue number and follows one of Waffle's patterns)
• it puts pull requests into the Review column
• it displays a pull request together with the issue it solves (provided you use GitHub's closing keywords in the PR)
• it moves closed issues to the Done column

For it to work we need to:

• Name our working branches according to a pattern that Waffle recognises
• Include the text closes #123 in the PR title or description

Naming branches

Why?

When you push to GitHub a branch named according to one of Waffle's patterns, Waffle automatically moves the issue to In Progress and assigns the issue to you.

How?

What to do

Create a branch following the pattern described below and push it to GitHub before you do anything else to update the Waffle board.

Naming pattern

The proposed pattern is type/#123-description where 123 is the issue number being addressed by the branch.

Examples:

• feature/#12-home-page
• bug/#167-submit-disabled

Connecting a new PR to an issue

Include the text closes #123 in the PR title or description

Why?

This is how GitHub automatically closes an issue related to a PR. See GitHub Help.

How?

It has to be in the exact format closes #123 and it has to be in the PR title or description, not in comments.

Writing it in a merge comment has no effect. Text like closes issue #123 doesn't work either.

Note: Other keywords have the same effect and you can close multiples issues.