7  Workflow Pilots

This chapter is a collection area for promising workflow practices at Blueprint. Look here to see what other printers are experimenting with right now.

7.1 Using Github Issues to Host a Project’s Decision Log

Meta data
project FSC Benchmarks
repo alex-rand/fsc-benchmarks
contact (alex-rand?)

7.1.1 What is the practice?

  • use Github’s Issues tracker to:
    • ask and answer questions about program, data, and methods
    • collaboratively arrive at decisions about the best path forward
    • label conversations to help others focus their contributions
  • connect tasks (branches, pull requests) to the conversations that produced them

7.1.2 Why is it good?

  • lives in an obvious, highly accessible place attached to the project’s repo
  • enables transparent, asynchronous, collaborative decision-making
  • organically documents that process
  • provides an intuitive interface for tracking down the rationale for decisions which would otherwise be forgotten
  • labels make it easy to highlight issues for specific team members or cross-functional collaborators
  • code reviewers have a clear first stop for answering questions about decisions reflected in the code they’re reviewing

7.1.3 What does it look like?

7.1.3.1 Browsing open issues

A List of Github Issues

7.1.3.2 Filtering for the ones you might be able to help with

Filtered list of Gihub Issues

7.1.3.3 An active discussion

Discussing issue #30

7.1.3.4 Making a branch for work associated with an issue

Creating a branch connected to the issue

7.1.3.5 Searching past issues

Searching through closed issues