How to Use Waffle.io
to Make Collaborating Easier
Waffle is a project management tool for development teams that integrates seamlessly with GitHub. With it, you can easily organize your team’s to-do list and split tasks across multiple states like Backlog, In Progress, Ready to Review, and Done.
Waffle’s integration with GitHub makes seeing your team’s progress, getting an overall snapshot of what’s being worked on, and having a clear direction on what to focus on next a piece of cake.
Here’s what our current project looks like:
To get it set up for your repo, you create a new “board” on Waffle which organizes your team’s repo into the Waffle project board. Here, you can add issues and assign them to different members of your team. The GitHub repo must have the correct settings for your team members to be able to interact with the board, so if you notice issues, go to the repo’s Settings and enable the Waffle service in the “Webhooks & Services” tab.
To take advantage of some of Waffle’s features, you can have it automatically move tasks from “In Progress” to “Ready to Review” by titling your pull requests or commit messages in a specific manner so Waffle can interpret and handle the project management flow for you.
Including a keyword in the pull request’s title, ie. “resolves” lets Waffle know to search for a specific task and move it to the “Ready to Review” session of your board. Pairing it with the task number, ie. “#3” tells Waffle to move Issue #3 for you. And once the pull request is accepted and merged, the issue will automatically be moved to the Done column. So to put it together, a sample pull request title can look like: “Resolves #3” and voila.
Other useful keywords are “close” and “fix”, which can be used the same way as “resolve”. The setup took our team only about 30 minutes to get up and running, and the interface was intuitive enough to not slow us down much even the first time we used it (other than the permissions issue, which I shared above). Getting used to Waffle was a worthwhile investment of our time since it helped us manage our workflow and improved our ability to collaborate.