Skip to content

Latest commit

 

History

History
83 lines (52 loc) · 2.96 KB

README.md

File metadata and controls

83 lines (52 loc) · 2.96 KB

WhatDidIDo

A php package to help developers figure out what they did so they can put it on their timesheet.

WhatDidIDo collects your commit subjects to copy/paste into your time tracker. The commits are assembled into single-line text blocks for each day. This makes it very easy to select the text.

Pro tip: try tripple clicking the text on a Mac - it selects the whole line.

Installation

The best approach is to install WhatDidIDo globally via composer so you can use it in any of your git repositories.

composer global require cogitools/whatdidido

Make sure it installed by checking the help.

whatdidido --help

Usage

Navigate on your command line to any project that is a git repo and WhatDidIDo will report your commits. By default it renders what happened yesterday and today, so that you can easily copy that into your timesheets.

whatdidido

---- 2018-07-25 ----
Initial commit. Updated gitignore. Updated the readme. Created the whatdidido php script. Updated composer json. Stupid typo in compoers json. Added home page to composer. Updated readme with better line breaks.
---- 2018-07-26 ----
Update readme installation instructions. Update readme with better usage instructions.

WhatDidIDo Parameters

Default (no parameter)
Display 2 days worth of commits (yesterday & today).
This is the most commonly needed set of commits.

-y/--yesterday
Display just yesterday's commits.

-t/--today
Display just today's commits.

-m/--multiline
Display the commits with each subject on it's own line.

-w/--with-body
Include the body of the commit as well as the subject.

-b/--before
Display the commits before a particular date.
This parameter is passed through to git log.

-a/--after
Display the commits after a particular date.
This parameter is passed through to git log.

-s/--since
Display the commits since a particular date.
This parameter is passed through to git log.

-u/--until
Display the commits until a particular date.
This parameter is passed through to git log.

Git Log Utility

This utility is a based on git log, which is an incredibly powerful repoting tool built right into git. If your reporting needs go beyond what we've provided here you should look into that, maybe starting with the git log docs.

Commit Harvester for Automated Commit Harvesting

WhatDidIDo is very useful for micro indy shops with no budget. But its biggest shortfall is that you have to go into each repo and run it to see what you did. If you're looking for a more complete, integrated, and automatic solution, so you never miss a billable commit, we've got Commit Harvester.

License

Licensed under the MIT license.

Cogitool Software

This package is another fine product of Cogitools Software.