summaryrefslogtreecommitdiff
path: root/doc/workflow
diff options
context:
space:
mode:
authorPatricio Cano <patricio@gitlab.com>2015-03-03 12:31:54 -0800
committerPatricio Cano <patricio@gitlab.com>2015-03-03 12:31:54 -0800
commit01bd632c66617378ee4410025166e3c8131d821c (patch)
tree43aea84b85d298a32f1429c3834630b1135f4d8c /doc/workflow
parent2f4656b5c7e2a9b351237432e76a7b928a1684b1 (diff)
downloadgitlab-ce-01bd632c66617378ee4410025166e3c8131d821c.tar.gz
Created documentation on how to fork a project.
Diffstat (limited to 'doc/workflow')
-rw-r--r--doc/workflow/README.md1
-rw-r--r--doc/workflow/forking/branch_select.pngbin0 -> 55352 bytes
-rw-r--r--doc/workflow/forking/fork_button.pngbin0 -> 68271 bytes
-rw-r--r--doc/workflow/forking/groups.pngbin0 -> 98109 bytes
-rw-r--r--doc/workflow/forking/merge_request.pngbin0 -> 60597 bytes
-rw-r--r--doc/workflow/forking_workflow.md33
6 files changed, 34 insertions, 0 deletions
diff --git a/doc/workflow/README.md b/doc/workflow/README.md
index 6e70235f5b8..7e3fc49f704 100644
--- a/doc/workflow/README.md
+++ b/doc/workflow/README.md
@@ -1,6 +1,7 @@
# Workflow
- [Feature branch workflow](workflow.md)
+- [Code forking workflow](forking_workflow.md)
- [Project Features](project_features.md)
- [Authorization for merge requests](authorization_for_merge_requests.md)
- [Groups](groups.md)
diff --git a/doc/workflow/forking/branch_select.png b/doc/workflow/forking/branch_select.png
new file mode 100644
index 00000000000..275f64d113b
--- /dev/null
+++ b/doc/workflow/forking/branch_select.png
Binary files differ
diff --git a/doc/workflow/forking/fork_button.png b/doc/workflow/forking/fork_button.png
new file mode 100644
index 00000000000..def4266476a
--- /dev/null
+++ b/doc/workflow/forking/fork_button.png
Binary files differ
diff --git a/doc/workflow/forking/groups.png b/doc/workflow/forking/groups.png
new file mode 100644
index 00000000000..3ac64b3c8e7
--- /dev/null
+++ b/doc/workflow/forking/groups.png
Binary files differ
diff --git a/doc/workflow/forking/merge_request.png b/doc/workflow/forking/merge_request.png
new file mode 100644
index 00000000000..2dc00ed08a1
--- /dev/null
+++ b/doc/workflow/forking/merge_request.png
Binary files differ
diff --git a/doc/workflow/forking_workflow.md b/doc/workflow/forking_workflow.md
new file mode 100644
index 00000000000..32cee3e4f3c
--- /dev/null
+++ b/doc/workflow/forking_workflow.md
@@ -0,0 +1,33 @@
+# Code forking workflow
+
+Forking a project to your own namespace is useful if you have no write access to the project you want to contribute
+to. If you do have write access, we recommend using the **[Code Branching Workflow](https://about.gitlab.com/2014/09/29/gitlab-flow/)**.
+
+## Creating a fork
+
+In order to create a fork of a project, all you need to do is click on the fork button located on the top right side
+of the screen, close to the project's URL and right next to the stars button.
+
+![Fork button](/forking/fork_button.png)
+
+Once you do that you will see a screen where you can choose the namespace, to where you want to add the fork. This page
+will contain the groups you have write access to. Choose one of the groups and the project will be added there.
+
+![Groups view](/forking/groups.png)
+
+After the forking is done, you can start working on the newly created repository. There you will have full Owner access,
+so you can set it up as you please.
+
+## Merging upstream
+
+Once you are ready to send your code back to the main project, you need to create a Merge request. Choose your forked
+project's main branch as the source and the original project's main branch as the destination and create the merge request.
+
+![Selecting branches](/forking/branch_select.png)
+
+You can then assign the Merge Request to someone so they can review your changes. After they have reviewed them, the will
+be added to the main project, if maintainer chooses to do so.
+
+![New merge request](/forking/merge_request.png)
+
+