When Using GitHub, Don’t Skimp on Commit History
Posted April 22, 2014 at 11:30 pm by Will Verduzco
GitHub has become the epicenter of most open source development work that is posted both here to the XDA forums and abroad. Part of the reason for this is that there are so many useful tools built into the platform that allow developers to do what they need to do efficiently, and without jumping through too many hoops. However, not every project uses all of the tools made available to GitHub’s users, and perhaps the biggest offense in “open source” projects is the lack of proper commit history.
Maintaining a proper commit history is very useful both for yourself and others working with your code. Not only does it help other developers understand the changes and additions you’ve added, but it also helps you keep track of your own project better. Sadly, there are many projects in which a static source code snapshot is shared and no repo fork or commit history given. This could be a result of laziness or because the developer has something to hide, but one thing is clear: It shouldn’t happen.
Thankfully, a detailed guide created by XDA Senior Member Mazda is available to help both new and seasoned developers efficiently clone a repo and maintain a full commit history. The guide covers both the terminal commands and the website options required. and the end result is a properly populated commit history, where other developers can learn from your experiences—in other words, true open source.
If you’re a developer looking to brush up on maintaining proper commit history, head over to the guide thread and give the thread a read.
Want something on the XDA Portal? Send us a tip!