Contribution Process

Not to sound process heavy, but through experience and best practicies we have landed on some flow to how changes happen to lightblue related projectcs. This document intends to capture that to make it clear how thinks should work.

NOTE: this is NOT set in stone! This is expected to change over time as better ways are developed and agreed on. If you disagree with this document it's a great topic for discussion on the developer forum!

Tools

There is one board setup on waffle.io to bring all issues into a single kanban board:

• documentation & development board

The flow of issues through each board is the same.

General Flow

Issues not ready for any action can be discussed on the developer forum, user forum, or opened directly as issues in the appropriate github repository. Once an issue is opened the general flow is outlined below.

Prepare Issue for Work

These steps are done by contributors in general.

1. Issue goes to "Backlog" column on waffle.io.
2. Someone assigns a milestone. [optional]
3. Issue is moved to "Ready" column when description is sufficient for work to begin.

Fix the Issue

Someone decides to work on the issue and:

1. Assigns the issue to themself.
2. Move issue to "In Progress" column.
3. Creates a fork of the master branch in their own user account on github.
4. Develop change in the fork.
5. Issue a pull request (PR) when work is complete.
   • The PR should reference the original issue(s) being fixed.
   • Ideally reference the issues being fixed in the subject of the PR so that waffle.io knows to link the PR to the issue.
6. The PR (and linked issue) are put in the "Ready For Review" column.

Merging Fixes

1. Someone other than the creator of the pull request reviews the pull request.
   • Blocking issues are noted in comments of the pull request.
   • Non-blocking issues are opened as new issues in the repo.
2. If there are blocking issues:
   1. The original author fixes the issue and makes comments about resolution on the pull request.
   2. The fixes are reviewed, if good continue, else repeat this section.
3. If review is good (no issues, clean merge, travis-ci build successful):
   1. The pull request is merged.
   2. If the original issue was not linked to the PR and therefore not auto-closed, the original issue should be closed manually.

For more details of the tags and columns in waffle.io, take a look (or even comment if you have any question) on this nabble thread.