README.md in trollolo-0.0.9 vs README.md in trollolo-0.0.10
- old
+ new
@@ -55,10 +55,28 @@
https://trello.com/1/connect?key=...&name=trollolo&response_type=token&scope=read,write
The board id is the cryptic string in the URL of your board.
+The `.trollolorc` file can also be used to set aliases for board ids. When set,
+you will be able to use the alias instead of the board-id in the various
+commands. E.g.
+
+With the following configuration
+
+```
+board_aliases:
+ MyTrelloBoard: 53186e8391ef8671265ebf9e
+
+```
+
+You can issue the command:
+
+```
+ trollolo get-cards --board-id=MyTrelloBoard
+```
+
## Creating burndown charts
Trollolo implements a simple work flow for creating burndown charts from the
data on a Trello board. It fetches the data from Trello, stores and processes
it locally, and generates charts which can then be uploaded as graphics to
@@ -127,5 +145,84 @@
`trollolo help burndown`.
### Example
![Burndown example](https://raw.githubusercontent.com/openSUSE/trollolo/master/examples/burndown-26.png)
+
+## Other SCRUM commands
+
+Trollolo supports SCRUM on Trello by using one board for the sprint and another one for planning.
+On these boards several lists are used to organize stories.
+
+The `setup-scrum` command creates the necessary elements. The names are taken from the configuration.
+If you change the names in Trello, you need to update theconfiguration in `trollolorc`.
+
+At the end of a sprint, after the review meeting, remaining cards can be moved back to the planning
+board with `cleanup-sprint`.
+Once the sprint backlog is ready, priorities can be added to the card titles with `prioritize`.
+Move the planning backlog to the sprint board with `move-backlog`.
+
+### Labels
+
+* `sticky`: used to mark cards which are not moved, like the goal card
+* `waterline`: for cards which are under the waterline
+
+### Lists
+
+* `sprint_backlog`: this list contains the stories of the current sprint
+* `sprint_qa`: any cards in the current sprint which need QA
+* `sprint_doing`: cards currently being worked on
+* `planning_backlog`: used to plan the next sprint, these cards will be prioritized
+* `planning_ready`: contains cards which are not yet estimated and therefore not in the backlog
+
+### Default Configuration
+
+These are the default names, add this to `trollolorc` and change as necessary.
+
+ scrum:
+ board_names:
+ planning: Planning Board
+ sprint: Sprint Board
+ label_names:
+ sticky: Sticky
+ waterline: Waterline
+ list_names:
+ sprint_backlog: Sprint Backlog
+ sprint_qa: QA
+ sprint_doing: Doing
+ planning_backlog: Backlog
+ planning_ready: Ready for Estimation
+
+The board names are not used to find the boards on trello.
+Since several boards can share the same name, they are only used when creating the SCRUM setup.
+
+### Examples
+
+Create the boards and lists:
+
+ trollolo setup-scrum
+
+Lookup the ID of the created boards and use them as arguments:
+
+ # https://trello.com/b/123abC/sprint-board
+ # https://trello.com/b/GHi456/planning-board
+
+ trollolo cleanup-sprint --board-id=123abC --target-board-id=GHi456
+ trollolo set-priorities --board-id=GHi456
+ trollolo move-backlog --planning-board-id=GHi456 --sprint-board-id=123abC
+
+You can use aliases, as described in the configuration section, instead of IDs.
+
+## Updating VCR specs
+
+Some specs use VCR to reply with stored Trello API replies. The specs are annotated with `vcr:` and `vcr_record:`. To
+re-record the stored replies, set `vcr_record:` to true and replace `dummy_settings` with `real_settings`.
+
+ describe Scrum::BacklogMover do
+ subject { described_class.new(real_settings) }
+
+ it "fails without moving if backlog list is missing waterline or seabed", vcr: "move_backlog_missing_waterbed", vcr_record: true do
+ expect { subject.move("neUHHzDo", "NzGCbEeN") }.to raise_error
+ end
+ end
+
+The VCR support methods will replace your Trello token and key with dummy values, before saving the replies.