Saturday, May 18, 2024

How to Contribute to Open Source (When You’re Not Exactly Scott Hanselman)

Datamation content and product recommendations are editorially independent. We may make money when you click on links to our partners. Learn More.

Sara Chipps is a software programmer specializing in ASP.NET/C#/SQL.

Some of you will remember my rant about open source, and how I couldn’t find time to do it and didn’t know how anyone could. That post caused a big backlash, lots of people wanted to know how I could say that without ever trying it. Many more shared their personal experiences getting involved in open source and loving it. They explained that it was something you MADE time for. So, to see if they were right I did make time. Let me just tell you, totally worth it.

Witty is a WPF project brought to you by some of the guys that do the Herding Code podcast. I initially reached out to Jon Galloway to see if I could get involved with their project. He explained that anyone that wanted to could get involved in Witty, and he linked me to this post by Scott Hanselman.

The post was very educational about the process for contributing, but I am no Scott Hanselman. There is a lot of green still left around these ears, and whether or not Scott Hanselman can do something is no indication if I can do it. I knew I would run into issues working on a new application in a new framework I hadn’t seen yet (WPF). However, I tried it anyway and I was able to contribute a conversation viewing module to this past Witty release (2.2). I can’t tell you how cool it is to think of the fact that so many people use this awesome project and I had a hand in it.

I thought that I would demonstrate to you guys how easy and rewarding it is to contribute to open source no matter what level you are at.

Ok, so the first step is figuring out what change you are going to make. I find that the best way to to do this is to actually use the application.

how to contribute to an open source project

I actually got this idea for a feature through a tweet someone sent me about usernames not turning into links when they are prepended by a character. This became more noticable when the changes to replies were made and people were leading off
their tweets with a character so all their followers could see. So, I figured we could change this today.

Step one is getting the checking out the application through SVN. If you haven’t done this before check out this tutorial.

Now, what you want to do next is up to you. Some people might want to take a look around first, see how the application is set up. I did that initially, it enabled me to get a handle on how things where done and where things are located.

how to contribute to an open source project

I looked around at the file structure and kind of got a feel of where they stored things, there is a twitter library, and then the main application where the xaml is stored. Also, a skins project, common classes, and a test project.

Our first task today is to find where the usernames are being set as hyperlinks. My initial thought was that it was in the code behind for our xaml files. Or possibly directly in the xaml as a regex. I took a look around and didn’t find anything. It was frustrating, but after I pursued that direction for a while I thought to do a Cntl + Shift + F search for the character @. So I did that and found this region in my seach results:

how to contribute to an open source project

Jackpot! I found where they were setting the username as a hyperlink here in the OnTweetChanged method:

how to contribute to an open source project

Next Page: Final changes, Plus: “I’m glad I contributed”

As you can see they are treating each tweet as an array and then iterating through that array to check the words for @usernames and #hashtags. Initially, I was going to have this loop check for a word
either starting with, or having the second character be @, but then it occured to me that we only want to check that first word in the tweet, since this issue is only an issue in that first word. It’s adding more checks to each word to throw the logic into the loop and there has to be a better way
to do it.

I figured a great way to do this would be if I could separate the initial character and the @username into two separate parts of the array. I knew you couldn’t insert into a string array, but you can with an arraylist.

how to contribute to an open source project

I turned the array into an Arraylist and then I can make the first character and @username two words in the array. Then the loop will treat the see the @username for what it is and make it a link.

I was all set to check this in when I realized how much of a performance hit making the array into an Array List would be. So, I’ve gotta come up with something else. I decided to remove the functionality to format the @username from inside to loop, make it a method and call it before entering the loop if it falls in our char+username if statement, then call it from inside the loop if it is an actual username within the tweet.

how to contribute to an open source project

There we go and here are our final changes to the OnTweetTextChanged method:

how to contribute to an open source project

I tested again, and we’re looking great.

how to contribute to an open source project

Step next: submitting our patch.

how to contribute to an open source project

What you want to do is go to the svn folder where everything is contained right click as if you were committing your work however go to “Create Patch” instead. Select the files you changed and save the patch somewhere.

how to contribute to an open source project

SVN will show you a diff for your changes, go through and make sure you put everything in the patch.

how to contribute to an open source project

Now go to the Witty issues list, and submit your patch along with a comment about what it is doing and then submit!

That’s it! We’re golden. All together it took a little over an hour What have I gained here?

1. I got to add a feature I wanted to an application that I use.

2. After I submitted my first patch I got great feedback and critique from a developer I really look up to (Jon Galloway). You can have the same experience as long as the project you are working on is run by people you think are interesting.

3. I got to work with a new framework.

4. I feel like I’ve contributed something to the community, I walked around smugly for at least a few hours (j/k, but it’s cool).

Anyway, I hope this encourages you to get started. I’m certainly glad I did.

Subscribe to Data Insider

Learn the latest news and best practices about data science, big data analytics, artificial intelligence, data security, and more.

Similar articles

Get the Free Newsletter!

Subscribe to Data Insider for top news, trends & analysis

Latest Articles