Quassel IRC

h1. Getting started

{{toc}}

This guide guide describes how you get involved as new developer. If you only want to contribute patches you can checkout following guide about 

[[development_git_patches|Git patches]]

h2. Redmine

No source code change without an issue. Quassel project manages bugs and features with the redmine plattform. To get open issue (bug or feature) assigned, you have to setup account here on http://bugs.quassel-irc.org. 

"register here":http://bugs.quassel-irc.org/account/register

Please choose a nick identical or similar to your irc nick.

h2. Git

Install git on your operation system and configure it.

<pre>

git config --global user.name "First name and last name"

git config --global user.email registered@email.example.com

</pre>

Optional you can switch colorful output on.

<pre>

git config --global color.ui auto

</pre>

h2. Github

h3. Setup account

"register here":http://github.com

Please choose a nick identical or similar to your irc nick.

h3. quassel clone

Setup your personal clone of quassel. Fork the repository at http://github.com/quassel/quassel/

Switch to preferred directory for your projects like <code>/home/yournick/projects</code>. Now you can clone the personal quassel clone to local machine. 

<pre>

git clone https://github.com/yournick/quassel.git

</pre>

h3. ssh key

To push changes you will need a SSH key pair. To generate it on linux type the command:

<pre>

ssh-keygen -t rsa

</pre>

For more details or if you're on Windows or OSX you can check the "github help":https://help.github.com/articles/generating-ssh-keys for more info.

After following instructions, you should now have a private key like id_rsa and public key *id_rsa.pub* in your _~/.ssh/_. Upload the *public* key in your github account settings: https://github.com/settings/ssh

h3. ssh agent

_TODO_

h2. Workflow

h3. First step 

Get and issue to work on. If you have proper rights on redmine assign assign self, otherwise ask in irc to get it.

h3. Create branch

Remember do not work on master branch. Just create one branch for one.  

<pre>git branch branch_issue_x</pre>

h3. Switch to branch 

<pre>git checkout branch_issue_x</pre>

h3. Implementation

Work on this checkout - follow the normal development workflow...

h3. Commit

Commit changes to your local checkout 

<pre>git commit -a</pre>

Please try to merge all your commits to one.

_TODO EXAMPLE COMMAND_

*Note*: If you add _fixes #issue-number_ to your commit message, redmine will close your issue with the issue number.

h3. Publish 

To publish your changes just push it to github. -You will need running ssh-agent with your private ssh key as described above.-

<pre>git push git@github.com:yournick/quassel.git branch_issue_x</pre>

h3. Pull request

To submit your changes just create a pull request on github by clicking on the 'Pull request' button that's shown in several places. Alternatively just go to https://github.com/yournick/quassel/pull/new/branch_issue_x

h3. Cleanup

If your merge request is applied, you can delete your branch.

* local branch

<pre>git branch -D branch_issue_x</pre>

* remote branch

<pre>git push git@github.com:yournick/quassel.git :branch_issue_x</pre>

h3. Stay up to date

* Follow the main development branch by adding it as remote branch.

<pre>git remote add upstream git://github.com/quassel/quassel.git</pre>

* Update by pulling from the remote.

<pre>git pull --rebase upstream master</pre>

Now you can push the changes to your remote as described.

*Note* You should only push these changes to your remote master. *Do not push other changes to your master.*