Skip to content

Workflow

Jump to bottom Edit New page
Jonathan Reeve edited this page Jan 12, 2015 · 5 revisions

#MLA Commons Workflow This document describes ideas for a development workflow for MLA Commons using GitHub issues, optionally in conjunction with the kanban board waffle.io. Feel free to edit this document as you see fit.

An aggregated list of open GitHub issues can be found on the waffle board. Issues for individual repositories can be found on the issue trackers for those repositories (see "Repositories" below), the most notable of which is at https://github.com/mlaa/cbox-mla/issues.

##Prerequisites

##How to Create a New Issue

##How to Vote for Issues

  • Click on any issue number (click the number itself).
  • Add a comment with the text: :+1. This gets rendered as a thumbs-up icon.
  • Better yet, add a comment explaining why you think the bug should be fixed, or why the new feature should be implemented.

##How to Prioritize Issues

  • To mark an issue as high priority, click on that issue number, choose "Labels," and then add the label "priority."
  • To mark an issue as normal priority, remove any priority or wishlist labels it might have.
  • To mark an issue as low priority, assign the label wishlist to that item.

See also "Labels" below.

##How to Propose Issues to be Discussed in the Next Meeting

  • Drag any issue to the waffle.io column "Meeting Agenda," creating the item first if necessary.
  • Alternatively, add the label meeting-agenda to any item.

##Labels

###These labels can help to categorize issues:

  • bug - any problem with the site.
  • enhancement - ideas for new features or other improvements to the site beyond the fixing of problems.
  • UI - anything relating to user interface. Does a button look strange? Is some text wrapping in an unexpected way? These impact the user interface.
  • mobile - issues related to the mobile design, or how the Commons looks on phones and tablets (browser widths less than 768 pixels).
  • content - changes that need to take place in the content of the site, usually by editing a component using the WordPress front-end interface.

###These labels can be used to place issues in the workflow:

(Alternatively, drag issues to the appropriate columns in waffle.io.)

  • ready - issues that have been confirmed and are ready for development.
  • onhold - issues that are awaiting confirmation, discussion, or are contingent on fixing another issue first.

###These labels can be used to prioritize issues:

  • priority - issues with high priority.
  • (no label) - issues of normal priority.
  • wishlist - issues of low priority.

###These labels can be used for invalid issues:

  • duplicate - issues that are the same or very similar to other issues.
  • invalid - issues that are in some way invalid. For instance, these could be issues that apply to previous versions of the Commons, or issues that aren't reproducible on any browser.

###These labels can be used to mark issues for discussion:

  • meeting-agenda - issues to be discussed in the next meeting.
  • question - questions for discussion.

##Repositories Code for MLA Commons components resides in a few different GitHub repositories. The "master" repository is (traditionally, at least) cbox-mla. If you're unsure of where to add an issue, feel free to add it to the issue tracker for cbox-mla. If you want to get more specific, though, here's a list of MLA Commons pages with their corresponding repositories:

Add a custom footer
Add a custom sidebar
Clone this wiki locally