WhatToDo

As a developer you probably know that situation: You've been hacking in a project for some weeks and suddenly you're stuck or don't have any time to complete or have to stop developing for some other reason. The project stays untouched in the git repository and is idling. Dome weeks or months or even years later you want to get back in the project and finish it or fix a bug or somethine like that. But you don't know were the fuck you have quit the work in the project and have no idea what to do next.

The same issue occurs if you're joining a new project or want to start to contribute to an OpenSource project. You have no idea where to start.

WhatToDo is a tool which aims to help you over that obstacle, by analysing your project and telling you what you can do. It gives you concrete todos to help you to get startet with the project and get back into it.

Works for ruby projects only currently.

screenshot

(And this gem is under heavy development currently. Contributions are welcome.)

Dependencies

You just need at least ruby 1.9.3 installed.

Installation

gem install WhatToDo

Usage

Just run whatToDo in your project root.

License

The MIT License (MIT)

Copyright (c) 2013 Benjamin Kammerl aka phortx

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.