This week was actually pretty alright. Once I noticed that looking for issues on the GitHub app on my phone was pretty easy, actually doing the looking on my commute to work was even easier. I very quickly found multiple simple issues I was eager to fix.
I want to be clear, I did two pull requests this week because I wasn't terribly happy with my last one. I submitted the pull request and got no real response, but I decided I wanted to have something done so I threw it up there.
In hindsight, I'm really not happy with it.
So to make up for it, this week I did two! Both are of roughly equal quality but slightly more than or on par with what I would expect from a first PR. The first was simple documentation.
Replace putout-plugin to @putout/plugin in README files of packages directory
#26
- [x] Replace
putout-pluginto@putout/pluginin headers ofREADME.mdinpackagesdirectory similar to https://github.com/coderaiser/putout/commit/ea083359b1c082cb291b3d5ac218820eeaa5acea - [ ] Update
trueto"on"similar to https://github.com/coderaiser/putout/commit/1dcbd9365497c966f141f9162f23846c60f90d33.
As you can see, all the issue required was for documentation to have updated headers that reference the new name for the app.
Simple! I branched off the main branch and spent some time updating headers. Though I could've used replace all in vscode, I preferred to be a little more holistic and review the files to make sure I only changed headers. That was all the issue called for after all!
The pull request was happily accepted and I went on to the next issue.
Docs: fix readme headers to show @putout/plugin instead of putout-plugin
#27
Went through each folder in the packages/ folder and changed the headers to reference @putout/plugin instead of putout-plugin.
Addresses issue #26
The second issue I worked on this week was a quality of life edit of some code in fetch-json
Switch to trailing comma style for multiline arrays and objects in spec/node.js
#20
Including a comma for the last item in multiline arrays and objects makes the code more consistent and easier to edit. The consistency helps reduce merge diffs.
See example line in spec/node.js that needs a trailing comma: https://github.com/center-key/fetch-json/blob/master/spec/node.js#L36
Including a comma in multiline arrays seems like a superfluous decision on the part of a developer, but truthfully, it can save a lot of hassle when it comes to modifying code and it helps stop merge conflicts because if every array has a trailing comma, they are all consistent with each other.
Again, quite an easy fix. I once again branched off from the original and got to work, just working in the specified file, adding a couple of trailing commas.
I want to be clear again that I don't think either of these pull requests is really up to the standard of a 3rd week pull request when it comes to the complicated nature of the edits. But, making up for last week's submission is what I meant to do and fixing these issues showed me how nice it is to just work on someone else's project because you want to.
Low-stress fixes like these are all over the place and even when I'm done with this month having completed more complicated pull requests I'll probably be fixing trailing commas on every project I can find.
It's just fun!
Top comments (0)