Using GitHub

Contributors: Nate


Wiki and Issues

There are some additional tools built into GitHub as well. Issue Tracking allows folks to post problems or issues with a given project. It’s kind of like a ticketing system or tech support but with the ability to comment on a specific line of code.

alt text

Here’s is an example of creating an issue. Nothing too extraordinary but it allows for a good dialog between collaborators. You can see all the open issue on the Github_Tutorial project here.

alt text

Every repo also has a Wiki built in.

alt text

We’ve found the the wiki (this is from OpenLog) is a great place to have documentation for a given project or product. As the PCB layout, firmware, and example code changes over time we can update the documentation as well. Collaborators can also help maintain and improve the documentation. GitHub has been pretty powerful over the past few years increasing the ability for SparkFun to collaborate and improve our hardware designs.

Try using Git and GitHub for your next project. There’s an undeniable learning curve but it will make it much easier to collaborate with people.

Now that you’ve got repos under control we recommend you check out these tutorials:

Want more information about SparkFun's classes? Interested in getting involved with teaching electronics? Just want to talk? Sign up for our newsletter, or contact our education department.

SparkFun is a company built around one core idea – sharing ingenuity. We think everyone should have the hardware and resources to learn and play with cool electronic gadgetry.

Share, give, learn, SparkFun.

Do you regularly instruct classes and workshops in a formal or informal learning environment? SparkFun offers Educator Discounts to people teaching and sharing electronics.

Find out more.