Skip to main content

My First Pull Request Was Approved! Huzzah!

A few hours ago, I submitted my first ever pull request. I mean to something other than the Hello World project Github walks you through to show you the basics.

It has now been approved by the maintainer and merged. And, wow, I need to get this off my chest: You programmers are completely unnecessarily scaring off non-programmers from your Open Source projects.

This is how this went down:

I saw a piece on Hacker News that interested me and I opened it up to find that it was a Github repository. I began reading the documentation and noticed a typo.

One of the titles said "Funtion" instead of "Function" in it. So I was like "I would like to tell them."

Now the last time I wanted to tell someone in Open Source they had a typo, I left a comment on Hacker News to do it. They did fix it and apparently took some of my other advice as well.

But this time the article didn't have a lot of comments. It only has two, in fact. So I felt like leaving a comment on HN wouldn't accomplish anything.

But I had no idea how to do this. Do I open an issue? Do I just submit a pull request?

So I started a long comment on HN to ask how I should do this. It's just one freaking letter added to a word. It seems like opening an issue and telling someone else to fix it is makework.

But is someone going to bite my head off if I just submit a pull request? How does that work? What are the cultural norms? Who is allowed to submit a pull request?

So I wrote and rewrote this long comment wringing my hands and never posted it. Instead, I updated my password to my Github account and started to do the Hello World tutorial again because it's been a zillion years since I logged in and I have no idea how to use Github.

That was getting on my nerves and I think I went to the store or something. I finally just went in to Github and looked around a bit, read some of the documentation and concluded that, yes, a pull request is the way to go here.

So I opened up a pull request and started to type. Then I got a pop up message saying "Pro tip" and something about "This field should be less than 50 characters. If you want to say more, put it in the description."

So I just wrote "Typo" in that field and moved my description to the next section. I submitted it and got a message that it had cleared all checks and was good to go to do whatever the next step was -- and I don't remember the details because I don't know the right words for this, but it wasn't hard.

A few hours later I had two emails, one approving the change and the other announcing that it had been merged with the master.

I have spent a long time trying to figure out how to contribute to Open Source as a non-coder and I have talked to other non-coders on Hacker News who were similarly interested and finding no path forward. It's incredibly opaque to a non-programmer.

But if you want to suggest a fix for a typo or something else small like that in the documentation, you don't need to talk to anyone. You don't need anyone's permission. You don't need to understand the culture.

You just need to submit a pull request and you can probably figure out how to do that even if you haven't done the Hello World exercise because I did that a zillion years ago and don't remember it and have no idea how Github works.

(You do need a Github account. If you don't already have one, you will need to set one up and that is also not hard: Email address, handle and password, basically.)

To non-programmers: You can get involved by submitting a pull request when you see a typo (or similar small issue).

To programmers: Good, god, you folks need to put up some kind of "Hey, stoopid!" simplified instructions somewhere that tell people like me that it's actually easy to get involved.
Found a typo? Submit a pull request!
Rant over.

Popular posts from this blog

Pivoting a Website

The website Aberdeen Art and Music began as an effort to consolidate three older websites into a single website for purposes of trying to create a local walking tour as a tourist asset for this small town. It later took on a new purpose and I was tasked with updating the site to preserve and enhance the existing purpose while making room for new functions. The older websites were static sites that each corresponded to a printed brochure. The brochures and corresponding original websites were logically categorized by type of art: Murals, Critters and Urban Art (mostly sculpture). But much of this art can be found in close proximity in the downtown area, so I wanted to consolidate that information and enhance it to serve as an economic development tool for this small town. The intent was to support a walking tour via smartphone and begin phasing out the printed brochures while still supporting the existing brochures that were still out there and had the old URLs on them. In s

My Work

In the movie The Pickup Artist , Molly Ringwald's character utters my all-time favorite movie line: I'm too truthful to be good. I have apparently always been socially insightful. I was probably the bratty child yelling "The emperor has no clothes" and getting away with being rude, crude and socially unacceptable because I was cute as a button. When you are four, people laugh uncomfortably and don't explain to you why they are laughing. Being four, you stupidly think you are a talented comedian and then you spend your twenties and thirties baffled as to why everyone routinely gives you the death glare and wants your head on a pike instead of appreciating your witty insight and sense of humor. Me being me, I didn't stop being honest. I just tried to find ways to express myself that were less likely to have people wanting my head on a pike. This is a large part of why I blog. I still find social stuff very interesting, I see a need in the world for hig

Local News and Information Online

I recentely read an online article with local news. Nowhere in the article does it actually name the state and the name of the publication is generic enough it doesn't give clues as to the location. I poked around the site and found a county name somewhere, maybe in the same article, maybe in a different article. I googled the city name and the spelling is unusual such that it might be a unique city name though there are definitely other cities with names that sound the same. If this article were printed in a physical newspaper bought locally, using just the city name would be fine. You would know from context exactly which city was intended. But when an article is posted online, people can potentially trip across it from anywhere in the world. You are no longer talking to just locals and even if the city name is unique, not everyone will automatically know that. Don't assume your audience will go digging for more info like I did to try to figure out exactly where