We hear people say it all the time, but I would like to reiterate it. Any contribution you make to open source is a valuable contribution. Sure we all like adding features or fixing bugs in a project, but updating documentation is still worthwhile. I was reminded of this on the weekend.
My site is currently using Gatsby, an awesome React based static site generator on steroids.
For tweets on my blog posts, I had installed the gatsby-plugin-twitter about a year ago. It was working well for me, but then I came across this tweet.
My first ever @npmjs package! Yeah me 👊— Benedicte Raae (@raae) January 18, 2019
A @gatsbyjs plugin that lets you easily embed twitter, instagram, youtube, vimeo, codepen, soundcloud, reddit and more on your site!
Please try and report back :D
Example site: https://t.co/own82Sko24
NPM: https://t.co/NrTiMRd3jQ pic.twitter.com/JO6FRhA2Uo
I checked out the npm package, @raae/gatsby-remark-oembed and then followed the links to the repository and demo. It looked pretty awesome and fast and it supported much more than Twitter. I installed the package, copied the code snippet to add to my gatsby-config.js and was all good to go.
I fired up my development environment and I was getting errors about the plugin not being found.
Error: Unable to find plugin "gatsby-remark-oembed". Perhaps you need to install its package?
I was a little perplexed, read over things several times in the documentation and then came to the realization, that since the author published the package, the name of the npm package was not the same name, it was a scoped package, i.e.
@raee/gatsby-remark-oembed instead of
gatsby-remark-oembed (like in the code snippet in the documentation). I was glad I figured out what was up. I got the plugin running locally and then I published my site and was good to go. I was also happy to have migrated it to TypeScript, but we'll save that for another post.
Alright, got my @gatsbyjs site migrated to TypeScript. Pretty happy with the result. For those interested, check out https://t.co/fGUCMqvRaI . I'll probably write a blog post about it in the next week or so. #reactjs #TypeScript— Nick Taylor (he/him) (@nickytonline) January 20, 2019
At this point, I was like, well if I spent 15-20 minutes trying to figure out what was up, I'm sure others would appreciate what I had discovered, so I put up a PR to update the documentation. It got merged and I felt just as good about adding these 6 characters,
@raae/ to the code snippet in the documentation as I do when I fix a bug or add new functionality to a project.
Every contribution to open source is valuable.
So much fun so to have ones own @npmjs package 🎉— Benedicte Raae (@raae) January 21, 2019
Already had my first pull request. Thanks to @nickytonline for catching an error in the example code. Much appriciated!
Check out the plugin: @gatsbyjs-remark-oembed.#JAMstack #webdev pic.twitter.com/A6FZ2m9Vcy
Thanks for the thanks @raae!