mirror of
https://github.com/wahyd4/gitlabhq.git
synced 2026-08-25 04:26:08 +10:00
Merge branch 'doc_forking_refactor' into 'master'
Refactor forking workflow documentation Closes #5974 See merge request !2623
This commit is contained in:
Binary file not shown.
|
Before Width: | Height: | Size: 67 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 96 KiB |
@@ -1,36 +1,59 @@
|
||||
# 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.
|
||||
Forking a project is in most cases a two-step process.
|
||||
|
||||

|
||||
|
||||
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.
|
||||
1. Click on the fork button located in the middle of the page or a project's
|
||||
home page right next to the stars button.
|
||||
|
||||

|
||||

|
||||
|
||||
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.
|
||||
---
|
||||
|
||||
1. 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.
|
||||
|
||||

|
||||
|
||||
---
|
||||
|
||||
**Note:**
|
||||
If the namespace you chose to fork the project to has another project with
|
||||
the same path name, you will be presented with a warning that the forking
|
||||
could not be completed. Try to resolve the error and repeat the forking
|
||||
process.
|
||||
|
||||

|
||||
|
||||
---
|
||||
|
||||
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](merge_requests.md).
|
||||
|
||||

|
||||
|
||||
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.
|
||||
|
||||

|
||||
|
||||
|
||||
[gitlab flow]: https://about.gitlab.com/2014/09/29/gitlab-flow/ "GitLab Flow blog post"
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 69 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 26 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 22 KiB |
Reference in New Issue
Block a user