Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

Feature: iteration status badge #2

Closed
dominictarr opened this Issue Jan 2, 2014 · 2 comments

Comments

Projects
None yet
1 participant
Owner

dominictarr commented Jan 2, 2014

The status of an iteration is displayed via a png,
just like a travis ci badge.
http://about.travis-ci.org/docs/user/status-images/

this provides a very simple way to add a third party semi-dynamic element into another site. It's a technique already used by a number of github services.

In the context of feedopensource a iteration status would probably show:

  • number of tasks (bugs, features, etc) that are involved, incomplete, complete, etc
  • percentage funded (or whether it failed to be fully funded)
  • whether work on the iteration has started.

probably this can be implemented as a progress bar that goes through two stages - first it shows the funding building up, and then when work on that iteration begins, it shows the proportion of tasks that are complete (a task is considered complete when the issue has been closed)

A badge would be added to the page like this:

[iteration badge](https;//feedopensource.com/iteration/{user}/{repo}/{wallet_id}.png#{target})

(edit: changed url pattern)

If feedopensource looked at the referer header, then it would know what github issue it was a part of and display information about just that issues!
Otherwise, feedopensource would read all the issues and (or use github api) to read find the new Iteration issue, and then parse it to find out which tasks are a part of that iteration.

The project maintainer creates a bitcoin wallet ({wallet}) for that iteration, and a target amount ({target} of bitcoins that they think they'll need to start working on / complete that iteration)

Because github aleady has back links for when an issue is refered to, you'll be able to see whether an issue is part of an iteration!

Owner

dominictarr commented Jan 2, 2014

The issue badge should also be a link that takes you to a page showing project history and giving you information needed to fund.

This was referenced Jan 2, 2014

Owner

dominictarr commented Jan 16, 2014

This isn't perfect yet - like, a empty badge is hard to read
(if it hasn't had any funding yet, look as #20 (if that has started it's too late)

But, this does show the basic information that needs to be shown, including progress on the iteration's tasks.

So, I'm gonna close this, and maybe we can make improvements next iteration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment