From e33df3f024f12dd97d3b401b0c9b82ffd73e765d Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Tue, 19 Jul 2016 18:02:19 -0700 Subject: [PATCH] doc: devguide: explain time annotations --- site/developer-guide.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/site/developer-guide.md b/site/developer-guide.md index bcd4047c9..a41e0355a 100644 --- a/site/developer-guide.md +++ b/site/developer-guide.md @@ -130,6 +130,20 @@ Clicking blue topic labels is a good way to review issues in a topic you're inte Milestones are used to organise releases. Click a milestone to see issues fixed in/planned for that release. +Time annotations: some issue names might have a suffix noting estimated and spent time. +Basic format: [ESTIMATEDTOTALTASKTIME|TIMESPENTSOFAR]. Examples: +``` +[2] two hours estimated, no time spent +[..] half an hour estimated (a dot is ~a quarter hour, as in timedot format) +[1d] one day estimated (a day is ~4 hours) +[1w] one week estimated (a week is ~5 days or ~20 hours) +[3|2] three hours estimated, about two hours spent so far +[1|1w|2d] first estimate one hour, second estimate one week, about two days spent so far +``` +Estimates are always for the total time cost (not time remaining). +Estimates are not usually changed, a new estimate is added instead. +Numbers are very approximate, but better than nothing. + ### Report bugs If you found a similar bug report already in the tracker, add any new information there.