Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: this is what broke everything #570

Merged
merged 1 commit into from May 5, 2021
Merged

fix: this is what broke everything #570

merged 1 commit into from May 5, 2021

Conversation

zoesteinkamp
Copy link
Contributor

@zoesteinkamp zoesteinkamp commented May 5, 2021

fix: force coercion of falsy values to 0

guards against https://github.com/d3/d3-scale/releases/tag/v3.2.4

Issue: on april 28th 2021, we found an issue when we upgraded multiple giraffe libraries. This resulted in our graphs intermittently coming back empty/blank. This was because we had originally believed the null values would return 0, as d3-scale did originally. But by upgrading this broke and we were receiving NaN values. These values made it so our graphs could not be displayed properly but only broke on graphs with undefined values.

Copy link
Contributor

@hoorayimhelping hoorayimhelping left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I got a chuckle out of the cheeky commit message, but let's think of posterity on this one. Describe with a little more detail what this fix is - it's funny now, I'll give you that, but in six months, I doubt we'll remember what 'everything' included when we 'broke everything'

Put it in your own style, but if it was me, I'd make this message something like:

fix: force coercion of falsy values to 0

guards against https://github.com/d3/d3-scale/releases/tag/v3.2.4

it gives a quick tldr in the first line, and then provides context by linking to the release in the detail part of the message

 we found an issue when we upgraded multiple giraffe libraries. This resulted in our graphs intermittently coming back empty/blank. This was because we had originally believed the null values would return 0, as d3-scale did originally. But by upgrading this broke and we were receiving NaN values. These values made it so our graphs could not be displayed properly but only broke on graphs with undefined values.
@zoesteinkamp zoesteinkamp merged commit 37c2eb5 into master May 5, 2021
@zoesteinkamp zoesteinkamp deleted the d3fix branch May 5, 2021 23:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants