Skip to content
Snippets Groups Projects
Commit 308cae88 authored by Alfin Johny's avatar Alfin Johny
Browse files

This is the first and preferred way to make a merge request, as it is similar...

This is the first and preferred way to make a merge request, as it is similar to our previous UNICADO workflow.
Let's assume you have cloned the Unicado Package repoistory and updated all it's submodules following [Get Source Code](../build-instructions/get-source-code.md ). Open your preferred IDE (e.g., Visual Studio Code). Ensure that Git is integrated within your IDE. Most IDEs, such as VSCode, have built-in Git integration. Go to the sub module where you want to make the change. Create your own (local) branch, where you are developing a new feature / fixing bug / addong documentation.
For a more detailed explanation of the steps mentioned below, watch the [Merge Request Workflow](contributor-tutorial/videos/Merge_Request_Workflow.mp4) video.
parent 1c16e01d
No related branches found
No related tags found
1 merge request!84Update how to contribute
Pipeline #1680261 waiting for manual action
......@@ -9,32 +9,24 @@ date: 2024-09-25
# How to create a merge request (MR)
You have already implemented an improvement to the current code base or intend to? Awesome 😎
Follow these steps to create a merge request (MR) from your forked repository:
Follow these steps to create a merge request (MR) from your cloned repository:
- First, make sure you have read [How to contribute to UNICADO](contribute.md)
- Then, proceed with the steps below:
UNICADO project is now on self hosted GitLab platform of RWTH. So you need to have write permission in the self hosted GitLab platform a GitLab if you want to create Merge Request and start contributing to it. But you can get a copy of UNICADO source code on your local machine( via cloning) and experment with it.
There are several ways to create a merge request within GitLab, which are explained in detail in the [official GitLab docs :octicons-link-external-16:](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html).
However, we will highlight the workflow, we prefer - but feel free to make your own choice.
## Preferred Merge Request Workflow for a Forked Repository
## Preferred Merge Request Workflow
### 1. Clone the repository and update it's submodules
This is the first and preferred way to make a merge request, as it is similar to our previous UNICADO workflow.
Let's assume you have forked( if you are not a direct member of UNICADO project) and cloned the Unicado Package repoistory and updated all it's submodules following [Get Source Code](../build-instructions/get-source-code.md ). Open your preferred IDE (e.g., Visual Studio Code). Ensure that Git is integrated within your IDE. Most IDEs, such as VSCode, have built-in Git integration. Go to the sub module where you want to make the change. Create your own (local) branch, where you are developing a new feature / fixing bug / addong documentation.
Let's assume you have cloned the Unicado Package repoistory and updated all it's submodules following [Get Source Code](../build-instructions/get-source-code.md ). Open your preferred IDE (e.g., Visual Studio Code). Ensure that Git is integrated within your IDE. Most IDEs, such as VSCode, have built-in Git integration. Go to the sub module where you want to make the change. Create your own (local) branch, where you are developing a new feature / fixing bug / addong documentation.
For a more detailed explanation of the steps mentioned below, watch the [Merge Request Workflow](contributor-tutorial/videos/Merge_Request_Workflow.mp4) video.
### 1. Configure Remotes:
Verify and set up remotes for your fork and the upstream repository:
```{ .cmd .copy }
git remote -v
```
Add the original UNICADO repository as the upstream remote:
```{ .cmd .copy }
git remote add upstream git@gitlab.com:unicado/unicado.git
```
### 2. Create a New Branch
......@@ -93,7 +85,7 @@ To propose your changes to the original UNICADO repository:
1. Go to the original UNICADO repository on GitLab.
2. Click Create Merge Request.
3. Set your forked repository's <new-branch-name> as the source branch and `main` in the original repository as the target branch.
3. Set <new-branch-name> as the source branch and `main` in the original repository as the target branch.
4. Fill out the MR details:
- Provide a clear title and description of your changes.
- Use the available MR templates for consistency. Select a suitable one from the dropdown menu. These templates are saved in merge_request_templates folder inside .gitlab
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment