summaryrefslogtreecommitdiff
path: root/doc/workflow/forking_workflow.md
diff options
context:
space:
mode:
authorAchilleas Pipinellis <axilleas@axilleas.me>2016-01-27 11:26:04 +0100
committerAchilleas Pipinellis <axilleas@axilleas.me>2016-01-27 11:26:04 +0100
commitaf52158ff83ac6de539af36eea729a59a23340fb (patch)
tree3b5b797b0edd2ba6da55bcff71a0dc8a564130f1 /doc/workflow/forking_workflow.md
parent6d50b3ebf2eb17950c4e31a4873a6238287a370c (diff)
downloadgitlab-ce-af52158ff83ac6de539af36eea729a59a23340fb.tar.gz
Conform to doc styleguide on max line length
Diffstat (limited to 'doc/workflow/forking_workflow.md')
-rw-r--r--doc/workflow/forking_workflow.md40
1 files changed, 24 insertions, 16 deletions
diff --git a/doc/workflow/forking_workflow.md b/doc/workflow/forking_workflow.md
index 8edf7c6ab3d..cf9dc01df53 100644
--- a/doc/workflow/forking_workflow.md
+++ b/doc/workflow/forking_workflow.md
@@ -1,36 +1,44 @@
# Project 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 or can request it we recommend working together in the same repository since it is simpler.
-See our **[GitLab Flow](https://about.gitlab.com/2014/09/29/gitlab-flow/)** article for more information about using
-branches to work together.
+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 or can request it, we recommend working together in the same
+repository since it is simpler. See our [GitLab Flow](gitlab_flow.md)
+document more information about using branches to work together.
## 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.
+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'll be presented with a screen where you can choose the namespace to fork to. Only namespaces
-(groups and your own namespace) where you have write access to, will be shown. Click on the namespace to create your
-fork there.
+Once you do that you'll be presented with a screen where you can choose
+the namespace to fork to. Only namespaces (groups and your own
+namespace) where you have write access to, will be shown. Click on the
+namespace to create your fork 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](../permissions/permissions.md) access, so you can set it up as you please.
+After the forking is done, you can start working on the newly created
+repository. There you will have full
+[Owner](../permissions/permissions.md) 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.
+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 to have them review your changes. Upon pressing the 'Accept Merge Request'
-button, your changes will be added to the repository and branch you're merging into.
+You can then assign the merge request to someone to have them review
+your changes. Upon pressing the 'Accept Merge Request' button, your
+changes will be added to the repository and branch you're merging into.
![New merge request](forking/merge_request.png)
-
+[gitlab flow]: https://about.gitlab.com/2014/09/29/gitlab-flow/ "GitLab Flow blog post"