bumbailiff

Keep your technical debt under control.

Usage no npm install needed!

<script type="module">
  import bumbailiff from 'https://cdn.skypack.dev/bumbailiff';
</script>

README

Bumbailiff

Keep your technical debt under control.

Check out our blog post to learn more about the concept behind this tool. Bumbailiff works on any git repository.

Installation

There are several ways of installing and running bumbailiff.

Node.js / NPM

If you have Node.js and NPM installed, you can use npx to execute bumbailiff:

npx bumbailiff

You can add bumbailiff to your Node.js project:

npm install --save-dev bumbailiff

Or alternatively:

yarn add --dev bumbailiff

Manual download

Download and decompress the archive of this repository in the directory of your choice:

curl -LO https://github.com/SmartBear/bumbailiff/archive/main.zip
unzip main.zip

Add the location of the bumbailiff-main/src dir to your $PATH.

Usage

bumbailiff 10

This will check that you git repository does not contain more than 10 days of accumulated TODO-days. To do so, bumbailiff will query your git repository and search for all the TODOs it can find, compute the age of each one and print out the sum.

The maximum debt age is optional and defaults to 14.

Set up on your project

After installing bumbailiff, you might want to set up a pre-push hook in your repository to prevent pushing if the tech debt limit has been reached:

echo "#\!/usr/bin/env bash\nbumbailiff" >> .git/hooks/pre-push && chmod +x .git/hooks/pre-push

Other development practice tools

At Cucumber and Smartbear, we also use other tools that make our software development practices as a (remote) mob more healthy:

Credits

This project is based off the original work of Aslak Helles√ły. Some of the bash work around bumbailiff was also inspired by Steve Tooke's retro-tools who was himself inspired by Nat Pryce's work.