Pull Request Structure

Truman — Fri, 07 Feb 2025 00:00:00 +0000

An all-too-familiar scenario: you open a pull request in github. It has no description. It has three commits: "WIP," "Fixes issue," and "Whoops formatting." It has 24 file changes littered around the codebase. Your coworker opens your PR for review and promptly closes their browser window. Why? Your pull request did not communicate the motivation, reasoning, and proposed execution of your change. It's a difficult proposition even in good conditions.

We can do better for ourselves and our fellow developers. Here are some strategies we use to make the intention of our own pull requests simpler to understand and their proposed changes easier to review:

Tale Telling

This will not be the first post to highlight how good a good commit message is. There's more we can do beyond a pithy description of a coherent unit of work. Commits can be made to tell a story in context from one to another: clearing the ground here; then, establishing the new system there; then, exercising the change in this path; finally, whoops, formatting. Rebase (-i) is a cantankerous but invaluable friend.

Illustration

Changes to a user interface can be described visually with a set of images, a gif, or a short voiceover walkthrough which focuses on the new experience. Show, don't tell, can be taken literally to great effect.

Exercise

We execute the code we're authoring in order to make sure it works, right? (Right?) A living system is usually more than the automated tests that we also include. Record your setup, and interaction, and outcome. Flip back and forth between your console/UI, the code, the database. Show how everything breathes together.

Finally, include a gif of a cute Koala at the end of your well-written description. Because diligent reviewers deserve a small treat.

The Opinion Zone™

Truman — Wed, 31 Jul 2024 12:21:03 +0000

Looking for a better way to share your opinions? We have some thoughts on how to do that. Read more below!

https://gobetweenlabs.com/posts/opinion-zone/origin

The Opinion Zone™ is a place for thoughts that Dan, Harrison, and Truman share about what it means to build good software products at a sustainable pace in a calm and helpful environment. This post describes its origin and use.

Thanks for your time and attention.

Hello World

Truman — Wed, 24 Jul 2024 14:46:55 +0000

Ever wonder if you're becoming unemployable? We did, and the only thing we could figure to do was to start our own company. Read about it below!

https://gobetweenlab.com/posts/hello-world

We're writing about the comings and goings of Go Between, and we're kicking off with our "Hello World" first post. We'd love to hear about your own entrepreneurial journey, trouble with naming things, or product building aspirations in the comments.

Thanks for your time and attention.

Musicbox

Truman — Sat, 17 Feb 2024 00:00:00 +0000

An office radio for your remote office

Many years ago I was part of a team that used the now-defunct plug.dj to take turns sharing music with one another during our workday. It was a magical and, due to their peculiar aesthetic and UX choices, inexplicable experience. At its heart, plug.dj allowed folks to pick songs that were then played for everyone simultaneously; this was fun, but more interestingly it often led to music-related anecdotes and other side-conversations that brought me closer to the folks I was working with.

Many years later, in the early history of Go Between, Musicbox started as a side project that sought to recreate the explicable parts of that early experience. Its core mechanic was similar: everyone queues songs, Musicbox cycles through in round-robin style and plays them. Where plug.dj focused on sharing music with strangers' dancing hyper-color avatars, Musicbox encouraged teams of people to connect over the tunes that had been chosen. It included chat, recommendations, and a feature that allowed you to "pin" a message as a memory to appear whenever a given song played in the future. Since the average person listens to music for 32 hours per week, we thought that getting coworkers to share part of their listening experience, and through that, to share part of themselves, might bring folks a little closer together.

When every nuanced human problem looks like a nail

As software engineers who moved to remote work during the pandemic and later started a remote company, we've had our share of uncanny-valley experiences that result from trying to use technology to facilitate connection. We've come to recognize that while technology can solve specific, defined issues, it often misses the subtleties of human interaction. The intention of Musicbox was not to serve as an all-encompassing solution for digital solitude -- but we've found that we like to build tools that speak to getting to know the people that we spend time with at work on a deeper, human, level.

As we used Musicbox we started having conversations like this:

While "Surfaces - Sunday Best" plays in the background

Dan: My sister originally shared this song with me and then I forgot about it until I was watching a recent episode of "Ted Lasso" and I was reminded of how happy this song makes me

Dan: Also, Ted Lasso is not only my favorite show right now, it's the only show I watch.

Spencer: Just watched the trailer, looks hilarious. I love Jason Sudeikis. Going to start watching that

At a parting of ways, we listen to "Nickelback - Photograph"

Truman: Did you know that Chad Kroeger and Avril Lavigne were married from 2013-2015?

Dan: https://www.theguardian.com/lifeandstyle/shortcuts/2017/may/15/avril-lavigne-melissa-cloning-conspiracy-theories

Dan: Was he though???

Truman: incredible. Reminds me of the "Bigger Luke" conspiracy: http://biggerluke.wikidot.com/bigger-luke

Spencer: I was just going to ask if you guys knew the obscure conspiracy theory about fake Avril Lavigne

During a 90s/00s kick with "Incubus - Stellar (Official Music Video)"

Truman: lol hey Incubus

Truman: "Stellar" reminds me of college because my freshman dorm neighbor would play Guitar Hero a _lot_. And then they graduated to Rock Band and played that a _lot_ after it came out.

Dan: was stellar in guitar hero? I don't remember that one

Truman: Yeah, it's in the first game -- https://guitarhero.fandom.com/wiki/Stellar

Dan: My best guitar hero songs were: the killers: when we were young; weezer: my name is jonas; bloc party: helicopter; rage against the machine: bulls on parade

Truman: I didn't play a ton of guitar hero myself, but I've heard "Don't Fear the Reaper" more times than I think anyone reasonably should

We listen to a lot of music in Musicbox (~12,000 songs enqueued in 2023), so please don't judge this incidental selection too harshly. And while these conversations are not the hearts-to-hearts strangers-turned-lifelong-friends via the magic of technology, they do highlight where a long day could be lightened by a shared Ted Lasso joke, or an awkward lunch whose ice might be broken discussing whether Avril Lavigne really was bodysnatched.

How to build a good product and fail to launch a good product business

Musicbox was a nights-and-weekends project, so we chose tools that we were familiar with: a single-page React front-end (still source-available!), and a Rails api (where we mostly wrote tests and followed reasonable engineering practices). We worked on features that were fun, and we made it work and then made it nicer afterward. We built Musicbox mostly because we wanted it to exist. We acknowledged but did not start with answering some of the questions that pose existential risk to real products: will teams of people pay for this thing? Can we reach an agreement with the music provider at a scale and cost that allows this whole thing to work?

After about a year of off-and-on effort, we felt that we had a product that was usable enough to receive feedback from humans other than ourselves. We had a landing page and a manifesto. We invited former teammates to try it with their new teams, and people seemed to get its value proposition. We had a "maybe" to our first question, but it turns out that we had a hard "no" to the second.

While most of Musicbox's machinery is source-agnostic with regard to the music it plays, we built it first in integration with YouTube videos. As more folks were using the tool and we began bumping up against the "starter" API quota, we realized that we'd finally have to reach out to Google to see what it would mean to share the product with more people. After agonizing over their quota increase request form for a few days, we submitted our best description of a Musicbox which used YouTube's features -- and that it would like to use them more -- but which was primarily its own product that focused on creating shared experiences for teams of professionals. Our request was summarily rejected with the note that Musicbox "re-implemented core YouTube functionality," and our API request quota was reduced to zero.

Afterward

The blunt response to our quota request drove home a simple point: probably don't try to build a product whose value depends upon a third party's ad-monetized service. We could have appealed, or pivoted to another music provider (we had considered Spotify with the requirement that users have a premium account), but by this time our fledgling company Go Between had taken on a much clearer shape and we were ready to turn our attention elsewhere. We were -- and still remain -- interested in exploring ways to help teams of folks get to know each other, although we would change our tack a bit. We did not yet change the "create it for ourselves first, and figure out how to market it later" approach; you can read more in our post on Marginal, "How to build a simple Rails CRUD application in just two years."

Musicbox's Top 10 for 2023

Musicbox still lives on, but just for our small team. I'm listening to synth with Dan while I'm finishing this post and he's updating styling on Go Between's website. In 2020 we listened to 10,000 songs; 9,000 in 2021; 12,000 in 2022; and 13,000 in 2023. Most recently over winter break I merged some work to make our annual recap, "Musicbox Unwound," easier to generate. The repos are available for anyone's perusal -- and if you get the itch to contribute and move this whole thing to Spotify, well, we'll happily figure out a revenue share.

Thanks for your time and attention.

DEV Community: Truman

Pull Request Structure

Tale Telling

Illustration

Exercise

The Opinion Zone™

Hello World

Musicbox

An office radio for your remote office

When every nuanced human problem looks like a nail

How to build a good product and fail to launch a good product business

Afterward