>From 131aa158c5ae264d59455ac508776a149f6e06ad Mon Sep 17 00:00:00 2001 From: Thomas Nichols Date: Mon, 10 Nov 2008 21:45:26 +0000 Subject: [PATCH] Updated documentation for sha-names. --- lib/ditz/plugins/sha-names.rb | 21 +++++++++++++++++---- 1 files changed, 17 insertions(+), 4 deletions(-) diff --git a/lib/ditz/plugins/sha-names.rb b/lib/ditz/plugins/sha-names.rb index 1322045..1107ea2 100644 --- a/lib/ditz/plugins/sha-names.rb +++ b/lib/ditz/plugins/sha-names.rb @@ -1,10 +1,23 @@ ## sha-names ditz plugin ## -## This world's-smallest-ditz-plugin uses the initial characters of the SHA id instead of -## an identifier like "ditz-999". +## This world's-smallest-ditz-plugin uses the initial 5 characters of +## the SHA id instead of an identifier like "ditz-999". Installing +## this plugin will cause all references of the form 'ditz-123' and +## 'engine-57' to change to '1a2bc', 'f33d0' and similarly memorable +## IDs. If you are comfortable working with them (your clients may +## not be...) these make all issue IDs unique across the project, so +## long as you do not get a collision between two 5-hex-char IDs. ## -## Usage: -## 1. add a line "- sha-names" to the .ditz-plugins file in the project root +## Without this plugin, the standard ID for an issue will be of the +## form 'design-123'. Whilst this is easier to remember, it is also +## liable to change - for example, if two ditz trees are merged +## together, or if an issue is re-assigned from one component to +## another. This plugin provides a canonical, immutable ID from the +## time of issue creation. +## +## Usage: +## 1. add a line "- sha-names" to the .ditz-plugins file in the +## project root module Ditz -- 1.6.0.2