burnchart/docs/IDEA.md

45 lines
2.8 KiB
Markdown
Raw Normal View History

2014-11-01 01:34:50 +00:00
#Idea
##Summary
2014-11-01 05:12:37 +00:00
An app showing a burndown chart for issues in a GitHub milestone. A choice of strategies for calculating the size of each issue to determine the progress. Running completely client-side apart from GitHub authentication via a Firebase service. In use by the community since 2012.
2014-11-01 01:34:50 +00:00
##Community
2014-11-02 00:44:37 +00:00
Anyone can contibute their time by working on issues. Read the [Architecture](ARCHITECTURE.md) document to get oriented. Ours are tracked in Assembly as [bounties](https://assembly.com/burnchart/bounties). You can use the contact form widget inside the app or [burnchart@helpful.io](mailto:burnchart@helpful.io) to contact the lead developer, Radek. You can also use [Tally](http://tally.tl/) to vote on upcoming features.
2014-11-01 01:34:50 +00:00
##Background
2014-11-01 05:12:37 +00:00
The project started in 2012 at the University of Cambridge in a bioinformatics team. The aim was to get better at estimating the workload for each release we were marking. The original app was running on Node.js. Then a major rewrite in 2013 moved it completely client side. Another rewrite is happening now, 2014, on the Assembly platform.
2014-11-01 01:34:50 +00:00
##Goals
2014-11-01 05:12:37 +00:00
Make developers better at managing their workload.
2014-11-01 01:34:50 +00:00
##Key Features
2014-11-01 05:12:37 +00:00
1. Running from the **browser**, apart from GitHub account sign in which uses Firebase backend.
1. **Private repos**; sign in with your GitHub account.
1. **Store** projects in browser's `localStorage`.
1. **Off days**; specify which days of the week to leave out from ideal burndown progression line.
1. **Trend line**; to see if you can make it to the deadline at this pace.
1. Different **point counting** strategies; select from 1 issues = 1 point or read size from issue label.
2014-11-01 01:34:50 +00:00
##Target Audience
2014-11-01 05:12:37 +00:00
Developers who use simple issue trackers like GitHub issues and want to graduate from the basic progress bar that GitHub provides.
2014-11-01 01:34:50 +00:00
##Competing Products
2014-11-01 05:12:37 +00:00
The burndown or burndown chart concept is pretty widespread in more enterprisey ([Jira](https://www.atlassian.com/software/jira), [PivotalTracker](http://www.pivotaltracker.com/), [ThoughtWorks](http://www.thoughtworks.com/products/mingle-agile-project-management)) software. These are too heavy.
2014-11-01 01:34:50 +00:00
2014-11-01 05:12:37 +00:00
There are also products that nicely integrate with GitHub ([AgileZen](http://www.agilezen.com/), [Scrumwise](https://www.scrumwise.com/features.html)). But these are not GitHub-first.
2014-11-01 01:34:50 +00:00
2014-11-01 05:12:37 +00:00
And finally products built on top of the GitHub API ([Burndown](http://burndown.io/), [SweepBoard](http://sweepboard.com/)). One is not pretty and one does not do charts yet.
2014-11-01 01:34:50 +00:00
2014-11-01 05:12:37 +00:00
This product puts the chart front and centre, as a place from which insights can be gained. Some people use Kanban boards, we use Burncharts.
2014-11-01 01:34:50 +00:00
2014-11-01 05:12:37 +00:00
##Monetization Strategy
2014-11-01 01:34:50 +00:00
2014-11-01 05:12:37 +00:00
I think that this product is useful but, like with [gitter.im](https://gitter.im/) or [david-dm.org](http://david-dm.org) hasn't reached a threshold where people would pay for it.