Wednesday, January 3, 2024

The dsu Ruby Gem Workflow - How to use it in everyday life as an Agile Developer

๐Ÿ‘NOTE: The dsu GitHub wiki is the currently the gold standard for dsu gem documentation and info on how I use dsu daily as an Agile developer; please head there for the most up-to-date information on dsu ๐Ÿ‘Š๐Ÿ’š

Perhaps I should have subtitled this blog as "How I use [dsu] in everyday life", because I'll outline how I use dsu every day as an Agile Developer.

If you're not familiar with the dsu ruby gem, you might want to familiarize yourself with the basics. The dsu github repository README.md and dsu github wiki would be a good place to start.

In the morning...

  • View yesterday's DSU entries.
    • dsu list today # or `dsu l n` shorthand
  • If necessary, make changes to yesterday's DSU entries.
    • dsu edit yesterday # or `dsu e y` shorthand

Before Daily Standup (DSU)...

  • Add to or edit today's DSU entries
    • dsu edit today # or `dsu e n` shorthand
    • dsu add "Somethings I need to share at DSU today..." # or `dsu a` shorthand, repeat as necessary

NOTE: dsu edit SUBCOMMAND - If there are no DSU entries for today, dsu will search today - 1 (searching back at most today - 7) and copy the most recent DSU entries found, into the editor session, IF the dsu carry_over_entries_to_today configuration setting is 'true'.

Throughout the rest of the day...

  • Add, edit or delete one or more entries using the editor
    • dsu edit today # or 'dsu e n` shorthand
    • dsu edit yesterday # or 'dsu e y` shorthand
    • dsu edit tomorrow # or 'dsu e y` shorthand
    • dsu edit date 1/3 # or `dsu e d 1/3` shorthand, edits the date for the current year when yyyy is omitted
  • Add a single entry to today, yesterday, tomorrow or some arbitrary date
    • dsu add "Some entry description" # or `dsu a` shorthand, repeat as necessary
    • dsu add --today "Some entry for yesterday" # or `dsu -n` shorthand
    • dsu add --yesterday "Some entry for yesterday" # or `dsu -y` shorthand
    • dsu add --tomorrow "Some entry for tomorrow" # or `dsu -t` shorthand
    • dsu add --date "Some entry for 1/3/2023" # or `dsu -d` shorthand
  • List entries for today, yesterday, tomorrow or some arbitrary date range
    • dsu list today # or `dsu l n` shorthand
    • dsu list yesterday # or `dsu l y` shorthand
    • dsu list tomorrow # or `dsu l t` shorthand
    • Lists one week of DSU entries back from today's date (see ⚓ below)
      • dsu list dates --from today --to -6 # or `dsu l dd -f n -t -6` shorthand
    • Lists DSU entries within a date range
      • dsu list dates --from 12/1/2023 --to 1/3 # or `dsu l dd -f 12/1/2023 -t 1/3` shorthand
  • Bulk delete entries for today, yesterday, tomorrow, a particular date or arbitrary date range
    • dsu delete today # or `dsu d n` shorthand
    • dsu delete yesterday # or `dsu d y` shorthand
    • dsu delete tomorrow # or `dsu d t` shorthand
    • dsu date 1/3/2024 # or `dsu d d` shorthand
    • Deletes one week of DSU entries back from today (see ⚓ below)
      • dsu dates --from today --to -6 # or `dsu dd -f n -t -6` shorthand
    • Deletes one week of DSU entries from 12/15/2023 forward
      • dsu dates --from 12/15/2023 --to +6 # or `dsu dd -f 12/15/2023 -t +6` shorthand
    • Browse DSU entries for the current week, month and year
      • dsu browse w # or `dsu b w` shorthand
      • dsu browse m # or `dsu b m` shorthand
      • dsu browse y # or `dsu b y` shorthand

⚓ See `dsu list help dates` for more information on dates, mnemonics (today, yesterday, tomorrow) and Relative Date Mnemonics (e.g. -6, +3, -1, +1 etc.) 

The dsu gem has a whole host of other useful commands to manage your DSU entries. For more information, see dsu help: `dsu help`.

To install dsu, visit RubyGems.org web site.

Enjoy! ๐Ÿ˜Š๐Ÿ’›

Rubygems.org: https://rubygems.org/gems/dsu
Github: https://github.com/gangelo/dsu
Github dsu wiki: https://github.com/gangelo/dsu/wiki


No comments:

Post a Comment

The dsu Ruby Gem Workflow - How to use it in everyday life as an Agile Developer

๐Ÿ‘NOTE: The dsu GitHub wiki  is the currently the gold standard for dsu gem documentation and info on  how I use dsu daily as an Agile deve...