If you’re a developer who wants to work on the Diaspora source code and submit your changes for consideration to be merged into core Diaspora* code, here’s how. Thanks to ThinkUp for their awesome developer guide, which inspired ours.
- 1 Branching model
- 2 Quickfire Do’s and Don’t’s
- 3 Step-by-step (the short version)
- 4 Step-by-step (the long version)
- 4.1 Install git and git-flow
- 4.2 Create an account on GitHub and fork the Diaspora repository.
- 4.3 Establish connectivity between your GitHub account and your development machine.
- 4.4 Clone your GitHub fork to your development machine
- 4.5 Figure out what to work on
- 4.6 Create an Issue-Specific Feature Branch
- 4.7 Write awesome code
- 4.8 Keep Your Repository Up to Date
- 4.9 Rebase Your Development Branch on the Latest Upstream
- 4.10 Send Diaspora a pull request on GitHub
- 4.11 Some gotchas
- 4.12 What’s git-rebase?
In short it can be summarized as follows:
- tracks the released code, release tags are created off of it
- this is where development happens. pull requests should be issued against this branch
- features are worked on in their own branches, based on the develop branch
- hotfix branches are for fixing issues between scheduled releases. these are based on the master branch and are merged into both, develop and master
- these are for preparing some final steps before a release is tagged (as a normal contributor, you won't be needing to do these)
To make following this model easier we use git-flow utility which adds additional high level commands for swiftly handling the branching model. Please start by installing the git-flow extensions as per installation instructions on their project page. There is also a blog post explaining in short how git-flow basics work.
Discussion on improving this branching model happens on Loom.io.
Our usage of the git-flow extensions for Diaspora* does not stop the usage of vanilla Git commands! If you are not able to use git-flow or do not feel comfortable with using it, please feel free to use normal git commands. But we do enforce the branching model so please read the branching model post carefully and follow the guidelines closely.
Quickfire Do’s and Don’t’s
If you’re familiar with git and GitHub, here’s the short version of what you need to know. Once you fork and clone the Diaspora code:
- Never, ever, do anything in master branch. The branch develop is the head of development, master is for stable releases!
- Don’t develop on the develop branch. Always create a feature branch specific to the issue you’re working on. Name it by issue # and description. For example, if you’re working on Issue #359, an aspect naming fix, your feature branch should be called 359-aspect-names. If you decide to work on another issue mid-stream, create a new branch for that issue–don’t work on both in one branch.
- Do not merge the upstream develop with your feature branch; rebase your branch on top of the upstream develop.
- A single feature branch should represent changes related to a single issue. If you decide to work on another issue, create another feature branch from develop.
Step-by-step (the short version)
- Fork on GitHub (click Fork button)
- Clone to computer ($ git clone email@example.com:you/diaspora.git)
- Don’t forget to cd into your repo: ($ cd diaspora/)
- Set up remote upstream ($ git remote add upstream git://github.com/diaspora/diaspora.git)
- If you use git-flow initialize it: git checkout master && git flow init -d && git checkout develop
- Start working on a new issue or feature ($ git flow feature start 100-description, naming convention is issuenumber-description, if you don’t have a bug report no worries just skip the number)
- Develop on feature. ($ git add . ; git commit -m 'commit message')
- Push branch to GitHub ($ git flow feature publish 100-description or simply git push -f, just to stop you losing local changes on the event of hardware failure)
- Fetch upstream ($ git fetch upstream)
- Update local develop ($ git checkout develop; git pull upstream develop)
- Switch back to feature ($ git flow feature checkout 100-new-feature ; git rebase develop)
- Repeat steps 6-9 till dev is complete
- edit Changelog.md adding a line describing your change in the appropriate section
- Rebase develop in to feature branch ($ git rebase develop feature/100-description)
- Publish feature branch to Github ($ git flow feature publish 100-description)
- Issue pull request for develop branch (Click Pull Request button)
Note! Do not do git flow feature finish for your branch. Submit the whole feature branch as a pull request instead without finishing it. It will be merged to develop by a reviewer.
Step-by-step (the long version)
If you’re new to git and GitHub, here’s the longer version of these instructions.
Install git and git-flow
- Install Git for your platform
- Install git-flow extensions IF available for your platform
- (Optional but highly recommended) Install git-flow completion for some bash auto-complete magic
Create an account on GitHub and fork the Diaspora repository.
- Create a free account on GitHub, and log in.
- Go to the main Diaspora page on GitHub.
- Click the “Fork” button near the top of the screen. This will get you your own copy that you can make changes to. File:Http://img.skitch.com/20101018-j5xmmrs6ccn9ku2gic12y13cf9.png
Establish connectivity between your GitHub account and your development machine.
- Generate an SSH key on your development machine. Here’s a “good guide”:http://help.github.com/key-setup-redirect that gives you specific directions for whatever OS you’re accessing the page with.
- Make sure you’ve got an SSH public key on your machine and recorded in your GitHub account. You can see your SSH Public Keys on the Account Overview section of your GitHub account. File:Http://img.skitch.com/20101018-nayqmm1ne8qdyafpjb7tib4fi4.png
- To test the GitHub authentication run:
$ ssh firstname.lastname@example.org
If all is well, you should see something like this:
PTY allocation request failed on channel 0 ERROR: Hi username! You've successfully authenticated, but GitHub does not provide shell access Connection to github.com closed.
Clone your GitHub fork to your development machine
Run a clone command against your GitHub fork. It will look something like this except that it will use your GitHub account name instead of “you”:
$ git clone email@example.com:you/diaspora.git
That downloads your copy of Diaspora to a git repository on your development machine. Change directory into the new diaspora directory.
Check that you have git-flow installed and run
$ git checkout master $ git flow init -d $ git checkout develop
Now you need to install everything you need to run it - which is quite a lot of stuff. We have a guide to installing and running Diaspora which should help. Pop into #diaspora on IRC (freenode) if you have problems.
You’ll know you’re done when you can run specs (in two stages - the cucumber features, which are selenium acceptance tests, and the rspec tests, which are unit tests) by doing this:
$ rake spec
We try to make sure these always succeed. Our continuous integration server will tell you if there any current failures. If you have any test failures that you don’t see on CI, come ask in the #diaspora-dev IRC channel.
Figure out what to work on
Maybe you have a feature addition in mind, but if not, check out our issue tracker, or come ask in IRC what needs doing.
Create an Issue-Specific Feature Branch
Before you start working on a new feature or bugfix, create a new feature branch in your local repository that’s dedicated to that one change. Name it by issue number (if applicable, if there’s no issue just skip it) and description. For example, if you’re working on issue #359, a aspect naming bugfix, create a new branch called 359-aspect-names, like this:
$ git flow feature start 359-aspect-names
Write awesome code
You must write unit tests for all bug fixes, no matter how small. We can help you!
Edit and test the files on your development machine. When you’ve got something the way you want and established that it works, commit the changes to your branch on your development server’s git repo.
$ git add <filename> $ git commit -m 'Issue #359: Some kind of descriptive message'
You’ll need to use git add for each file that you created or modified. There are ways to add multiple files, but I highly recommend a more deliberate approach unless you know what you’re doing.
Then, you can push your new branch to GitHub, like this (replace 359-aspect-names with your branch name):
$ git flow feature publish 359-aspect-names
You should be able to log into your GitHub account, switch to the branch, and see that your changes have been committed. Then click the Pull button to request that your commits get merged into the Diaspora development trunk. This command may not work after the first run, if so you can just use :
$ git push -f
Keep Your Repository Up to Date
In order to get the latest updates from the development trunk do a one-time setup to establish the main GitHub repo as a remote by entering:
$ git remote add upstream git://github.com/diaspora/diaspora.git
Verify you’ve now got “origin” and “upstream” remotes by entering:
$ git remote
You’ll see upstream listed there.
Rebase Your Development Branch on the Latest Upstream
To keep your development branch up to date, rebase your changes on top of the current state of the upstream master. Check out What’s git-rebase? below to learn more about rebasing.
If you’ve set up an upstream branch as detailed above, and a development branch called 100-retweet-bugfix, you’d update upstream, update your local master, and rebase your branch from it like so:
$ git fetch upstream $ git checkout develop $ git pull upstream develop $ git flow feature checkout 100-retweet-bugfix [make sure all is committed as necessary in branch] $ git rebase develop You may need to resolve conflicts that occur when a file on the development trunk and one of your files have both been changed. Edit each file to resolve the differences, then commit the fixes to your development server repo and test. Each file will need to be “added” before running a “commit.”
$ git add <filename> $ git commit
To push the updates to your GitHub repo, replace 100-retweet-bugfix with your branch name and run:
$ git flow feature publish 100-retweet-bugfix
Send Diaspora a pull request on GitHub
Github will notify us and we’ll review your patch and either pull it in or comment on it
Helpful hint: You can always edit your last commit message by using:
$ git commit --amend
Be careful not to commit any of your configuration files, logs, or throwaway test files to your GitHub repo. These files can contain information you wouldn’t want publicly viewable and they will make it impossible to merge your contributions into the main development trunk of Diaspora.
Most of these special files are listed in the .gitignore file and won’t be included in any commit, but you should carefully review the files you have modified and added before staging them and committing them to your repo. The git status command will display detailed information about any new files, modifications and staged.
$ git status
One thing you may not want to do is to issue a git commit with the -a option. This automatically stages and commits every modified file that’s not expressly defined in .gitignore, including your crawler logs.
$ git commit -a
Using git-rebase helps create clean commit trees and makes keeping your code up-to-date with the current state of upstream easy. Here’s how it works.
Let’s say you’re working on Issue #212 a new plugin in your own branch and you start with something like this:
1---2---3 #212-my-new-plugin / A---B #develop
You keep coding for a few days and then pull the latest upstream stuff and you end up like this:
1---2---3 #212-my-new-plugin / A---B--C--D--E--F #develop
So all these new things (C,D,..F) have happened since you started. Normally you would just keep going (let’s say you’re not finished with the plugin yet) and then deal with a merge later on, which becomes a commit, which get moved upstream and ends up grafted on the tree forever.
A cleaner way to do this is to use rebase to essentially rewrite your commits as if you had started at point F instead of point B. So just do:
git rebase develop 212-my-new-plugin
git will rewrite your commits like this:
1---2---3 #212-my-new-plugin / A---B--C--D--E--F #develop
It’s as if you had just started your branch. One immediate advantage you get is that you can test your branch now to see if C, D, E, or F had any impact on your code (you don’t need to wait until you’re finished with your plugin and merge to find this out). And, since you can keep doing this over and over again as you develop your plugin, at the end your merge will just be a fast-forward (in other words no merge at all).
So when you’re ready to send the new plugin upstream, you do one last rebase, test, and then merge (which is really no merge at all) and send out your pull request. Then in most cases, a reviewer has a simple fast forward on her end (or at worst a very small rebase or merge) and over time that adds up to a simpler tree.
More info on the git man page here: Git rebase: man page