Contribution Workflow

After editing or creating files locally, contributions must be submitted through the Git workflow.

The general process is:

1. Clone or download the repository
2. Edit or create content locally
3. Create a new branch
4. Commit changes
5. Push the branch to the repository
6. Open a Merge Request
7. Wait for review and approval

All contributions follow the four-eyes principle and changes are reviewed by authorized maintainers before being merged into the main branch.

Creating a Branch in VSC

The following workflow is recommended when using Visual Studio Code with the integrated Git functionality. The general steps might differ depending on your software, but the principle of order stays the same.

Step 1 — Open the Repository

Open the cloned repository folder in VS Code.

Step 2 — Create a New Branch

1. Click the current branch name in the lower-left corner of VS Code
2. Select:

“Create new branch”

3. Enter a descriptive branch name, for example:

feature-new-hpc-training

4. Press Enter

Step 3 - Edit and Save Files

Modify or create the desired files. Make sure to include comments on code snippets.

Step 4 - Commit Changes

1. Open the Source Control tab
2. Review changed files
3. Enter a commit message, for example:

Added documentation for MPI introduction training

4. Click commit

Step 5 - Push the Branch

Click Publish Bransh or use the synchronization button in VS Code.

Step 6 - Create a Merge Request

After pushing the branch, open the Git platform in your browser and create a Merge Request.

The Merge Request should include:

• a short description of the changes,
• the purpose of the contribution and
• optionally references to related materials.

After review, maintainers may:

• approve the request,
• request revisions or
• discuss improvements collaboratively.

If the contribution workflow is too complex, simply send a markdown file to hpc-portal@hsu-hh.de!