OSS on Github – Tips and Tricks
This has come up a few times on a few projects so I thought I would share some tips and tricks that the Fubu team uses to manage the distribution of work. Call them conventions, rules, whatever works best for you.
These rules vary a little bit when you have commit rights to the central repo. The way I describe them here are rules for those that do not have commit rights.
Rule #1 – Don’t make changes to your local or remote master branches.
The master branch on the central repo (i.e., DarthFubuMVC/fubumvc.git) AND the master branch on YOUR fork belong to the framework team. Here’s an example:
I have a fork of DarthFubuMVC/fubumvc. At all times, my master branch must be an identical replica of DarthFubuMVC’s master. Of course, I may fall behind and not push the latest changes to my master. This is ok. The point here is that I cannot have changes to my master branch that are not in DarthFubuMVC’s.
Another good rule here is that your local branches should match your github repo’s (on origin). In other words, don’t save changes to your local master that aren’t on your github master. And since you shouldn’t have changes to your fork’s master that aren’t in DarthFubuMVC’s we can conclude with this:
Don’t make changes to your local or remote master branches.
Rule #2 – Pull requests should always come from remote branches
Given that you accept Rule #1, the only way to make changes is by branching. Therefore, in order to make changes public, you need to create a remote branch on your fork. Which leads us to rule #2:
Pull requests should always come from remote branches
This makes it much easier to maintain commit history and ensure that the proper commits are pulled in without the need (or least decreasing the need) for cherry-picking.
Rule #3 – Keep your trees trimmed
Commit history is good and it’s even better when it’s properly maintained. So don’t be the neighbor that lets his trees grow into your backyard and drop leaves everywhere.
It’s a simple process that keeps everybody happy:
- Branch for a feature
- Do some work and commit it
- Checkout master and pull the latest
- Checkout your branch and rebase on top of master
- Run a build
- Push your branch
- Issue your pull request
This ensures that your changes are applied on top of the very latest changes to master. It makes it easier to read, easier to pull in, and increases your chances of your pull requests being accepted.
So there it is, rule #3:
Keep your trees trimmed
These are the rules we follow for Fubu work but I think they’re generally applicable to most projects. What about you? What process do you use?
Major hat tip to Josh Flanagan, our resident master (not jack) of all trades and Git guru for establishing this process.