Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/benbenbenbenbenben/workitem

git based work item tracking
https://github.com/benbenbenbenbenben/workitem

agile iteration kanban workitem

Last synced: about 2 months ago
JSON representation

git based work item tracking

Awesome Lists containing this project

README 

        
#  .workitem  : the distributed work item tracker



workitem is a command line tool that puts work items where they belong, with your work! 



You can call it with `workitem` or `wi` and you can log new issues as quickly as you can say, well, exactly what the issue is!



`$ workitem add "debounce 'add again' button on main cart view" #bug ~1`



And that's it. A new issue. With the tag `#bug` and an estimated complexity of `~1`.



One line descriptions aren't enough? Run `workitem new` for the editor:



To get started, run `npm i -g workitem`, then in your git repo run `workitem init`



## Getting Started



#### To **add** an item do:



_Example:_



`wi add "fix terrible bug"`



You can optionally include as many `#tags` as you wish and specify a `~complexity` in whatever estimation language you prefer e.g. story points `~10` or t-shirt sizes `~medium` or weight in carrots `~20kg`. workitem is unit of effort agnostic in the same way that your project manager is supposed to be.



If your work item is dependent on another item, you can specify that dependency with the `<` and `>` characters.



`<` for example marks a work item as a child of, or smaller than, another. Adding a child item as follows, `wi add "a task that can't be completed yet" < ` _`f00b005`_, would prevent task `f00b005` being moved beyond the active stage of your newly created task in the work flow.



`>` makes the item a parent of another and thus means the new item cannot be moved beyond the child work item it references. The parent-child relationships between items are many-to-many in most cases but they can be configured otherwise (see [config](#config) to learn about good parenting)



#### To move an item with an _`id-or-index`_ do:



_Example:_



`wi move ` _`id-or-index`_ ` [to] doing [-f]`



Moving an item must be forced with `-f` if you are moving from and to workflow stages that are neither specified as transitionable nor permitted by parent-child relationships (see [config](#config) to learn about workflow transitions)



#### To show items do:



_Example:_



`wi`



Shows the current work item "board" truncated enough that it fits without much scrolling around.



_Outputs:_



![wi](https://github.com/benbenbenbenbenben/workitem/raw/master/docs/wi.PNG)



_Example:_



`wi show more`



Shows all the work items that are in your current iteration, and if you don't work in iterations, all those that are not archived.



_Outputs:_



![wi more](https://github.com/benbenbenbenbenben/workitem/raw/master/docs/wimore.PNG)



#### To note something on an item do:



`wi note` _`id-or-index`_ `"interesting findings Alice!"`



## Corrupt this Project



If you like .workitem and you would like the contributors to put your favoured features then you can