diff options
author | Sytse Sijbrandij <sytse@gitlab.com> | 2015-04-08 03:34:32 +0300 |
---|---|---|
committer | Sytse Sijbrandij <sytse@gitlab.com> | 2015-04-08 03:34:32 +0300 |
commit | 4b2aa9cd204ce1f0bf8859c1a64753b56c621cab (patch) | |
tree | 58e2d5441ca3de277a2356d9fdacbe2edb8aa2bc /doc | |
parent | 45c82b3845d90cc2453d58f1d9ca82e315ae6ac3 (diff) | |
parent | a332e7bd027d8d7f7f76f85d02c1594a4b5eb9c9 (diff) |
Merge branch 'forking-doc' into 'master'
Documentation on how to fork a project
Added documentation on how to fork a project.
/cc @sabba
See merge request !1623
Diffstat (limited to 'doc')
-rw-r--r-- | doc/workflow/README.md | 1 | ||||
-rw-r--r-- | doc/workflow/forking/branch_select.png | bin | 0 -> 55352 bytes | |||
-rw-r--r-- | doc/workflow/forking/fork_button.png | bin | 0 -> 68271 bytes | |||
-rw-r--r-- | doc/workflow/forking/groups.png | bin | 0 -> 98109 bytes | |||
-rw-r--r-- | doc/workflow/forking/merge_request.png | bin | 0 -> 60597 bytes | |||
-rw-r--r-- | doc/workflow/forking_workflow.md | 36 |
6 files changed, 37 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 Binary files differnew file mode 100644 index 00000000000..275f64d113b --- /dev/null +++ b/doc/workflow/forking/branch_select.png diff --git a/doc/workflow/forking/fork_button.png b/doc/workflow/forking/fork_button.png Binary files differnew file mode 100644 index 00000000000..def4266476a --- /dev/null +++ b/doc/workflow/forking/fork_button.png diff --git a/doc/workflow/forking/groups.png b/doc/workflow/forking/groups.png Binary files differnew file mode 100644 index 00000000000..3ac64b3c8e7 --- /dev/null +++ b/doc/workflow/forking/groups.png diff --git a/doc/workflow/forking/merge_request.png b/doc/workflow/forking/merge_request.png Binary files differnew file mode 100644 index 00000000000..2dc00ed08a1 --- /dev/null +++ b/doc/workflow/forking/merge_request.png diff --git a/doc/workflow/forking_workflow.md b/doc/workflow/forking_workflow.md new file mode 100644 index 00000000000..16a17290cb0 --- /dev/null +++ b/doc/workflow/forking_workflow.md @@ -0,0 +1,36 @@ +# 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 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. + +## 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'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. + +## 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 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) + + |