Building Rungs: Putting The Code on Github
This post is a continuation of the “Building Rungs” series. The first post is here.
As mentioned in previous articles, I would like to Open Source at least some of the code so that it is available to others. I’ve put things on Github in the past, but never from a Window’s PC. I’ll document the process here. Note, this article assumes you already have a Github account. If you don’t, you can get one here.
Before creating a new repo and uploading my code, I want to clean it up a bit. There will probably be an additional cleanup at some point, but for time being I want to at least make it a little more tidy. To do this, I’ve installed Sublime 2 (I have Notepad ++ as well, but want to use Sublime for this) and have all of my files sitting locally. Using FileZilla (and setting my default editor to Sublime), I can open up all of the files in my Rungs Beta directory and clean them up. In this case, I’m indenting them all using tabs (as opposed to spaces) and quickly looking through the code to make sure it’s not super messy. It’s in decent shape, so now I’m ready to make this puppy public!
Github: CMD or GitHub Client?
Using Window’s Command Prompt (or Terminal on Mac) versus using GitHub’s client is really a matter of personal preference. Arguably there may be certain actions you can take in CMD that you can’t in the client, plus some people are just more comfortable managing files in CMD anyway, but after using GitHub via Terminal for a year and a half, I want to give the Window’s client a try. To note, Github seems to encourage users to use a native client, probably because it can lead to more adoption (thanks to it’s GUI). I grabbed a copy from their official download page and followed the on-screen instructions to get started.
Being familiar with git terminology and comfortable with GitHub in general, I was able to figure out how to create a new repo, add my files and publish it with out any real problems. For anyone reading this who needs some extra help, this article might help.
It’s on GitHub! Now what?
In a very short period of time (about 20 minutes), I got the code up on to GitHub. So what does that mean? It means that anyone can take the code and use it in their own projects. Licenses are a different discussion for a different time, but technically anyone can easily grab the code without me every really knowing. This is not something I would do if I felt like this project contained anything proprietary. But why bother to share it at all? As cliche as it sounds, sharing is caring. I want to share my experience (hence the blog) as well as my code (at least for now) so that others can learn from both my success and failures. This opens up dialogue that can help me help others, as well as help others help me. I have a lot to learn and part of learning is, of course, dialogue.
In general Github serves as a great platform for open source contributions. You can view code, at times use it for own projects and join in with other developers to help them with their projects. It’s a really cool concept and although it’s far from being a new one, GitHub is constantly making things easier for low-level developers such as myself.