Collaborative Github Workflow

From eqqon

(Difference between revisions)
Jump to: navigation, search
(The example)
(Contributor's Workflow)
Line 8: Line 8:
== Contributor's Workflow ==
== Contributor's Workflow ==
=== Getting Started ===
=== Getting Started ===
-
If you want to '''start contributing''' to a project on github the first thing to do is to fork.
+
If you want to '''start contributing''' to a project on github the first thing to do is to fork it on github. Forking is the preferred way of collaboration on github and it works quite well. Follow the instructions on the site and clone a local copy of your fork to work with.  
<br><br>.... work in progress ..... going to complete it in the next days.
<br><br>.... work in progress ..... going to complete it in the next days.

Revision as of 14:53, 16 August 2009

Collaboration on Github is not complicated but also not intuitively clear for beginners because not all parts of the workflow are incorporated into the Github user interface. This description describes the structure of collaboration between the contributors and the maintainers github project. For every step in the workflow the respective git commands are given for reference.

The example

This description uses the project GitSharp a CSharp implementation of git as example.

The main repository also called the upstream branch is henon/GitSharp. The maintainers of this repository are responsible of merging in contributor's commits.

Contributor's Workflow

Getting Started

If you want to start contributing to a project on github the first thing to do is to fork it on github. Forking is the preferred way of collaboration on github and it works quite well. Follow the instructions on the site and clone a local copy of your fork to work with.




.... work in progress ..... going to complete it in the next days.