---
# System prepended metadata

title: Guidelines to do commits via Github
tags: [Operations]

---

---
tags: Operations
--- 

# Guidelines to do commits via Github
Before you are able to continue with these steps, please make sure that:
- You have set-up your Github account 
- You are able to do signed commits

### Choose your repository
This depends on the type of changes you would like to make. Most often this will be one of the following:
- *Operations* for o.a. the branding toolkit, onboarding flows, and operations guidelines. 
- *Website* for changes to the foundation website, such as adding blogposts, newsletters, releases, and faqs.
- *Client-web* for translations on the platform.

Now, several of these examples will be explained in detail to demonstrate the use of Github/VSCode:

### Small text updates to the Website, using Github
*In these guidelines we will use the example of changing text in one of the blogposts. However, the same applies for all other text updates you want to make. In the code and then the folder Content, you will find all the content of the website.* 
1. Go to the [Alkemio Github](https://github.com/alkem-io) and choose the [website repository](https://github.com/alkem-io/website)
1. On the left, you will see the **default branch** 'Develop'. Click on Develop and create **your own branch** to start making your changes. As a title use repository-issue number, for example website-1899. If it is not connected to an issue, use another clear name. And click create branch. When you are making changes, make sure that you are working on that branch.
![](https://hackmd.io/_uploads/B19k60S8n.png)
3. In the Code, navigate to **Content** > **Post** > and then choose the folder of the blogposts you would like to edit. In this folder you will find several images as well as a file called index.md. This is the file that contains all the text. Note that you can also navigate from content to for example faq, to change the text in any of the md files for the FAQ.
![](https://hackmd.io/_uploads/HkiHhCrU2.png)
5. Click on the edit icon to start changing the text
![](https://hackmd.io/_uploads/ryK-R0r8n.png)
and use preview to see if all appears well
![](https://hackmd.io/_uploads/rkfkCAr82.png)
7. Commit and add a message 'for example added text for blogpost'
8. Add any additional images to the same folder + make sure all names are lower-case and .png
9. Make sure the index refers to the right image titles ![](./name-of-image.png)
10. Go to Pull Request and all gone well, you will see a new PR to be compared.
11. Choose a title for the Pull Request, add a description if you want and choose a person to review
12. You can also create a draft PR if it is not yet ready for review
13. Wait until all checks are completed and use the deploy preview link to see if all the changes are correctly. 
![](https://hackmd.io/_uploads/rJZ9c0H8n.png)
13. After approval, you can merge the branch with develop and delete it

#### Adding a folder, for example for a new blogpost via Github
1. Follow step 1 and 2 of the above
2. Navigate again to content > post, but now we are going to make a new folder for a new blogpost
3. Click on Add file > create new file
4. Type in the year-month-short name
![](https://i.imgur.com/ETXA3fc.png)
5. Press / and type index.md
This is your document for the content of the blogpost
![](https://i.imgur.com/qAV5CY6.png)
6. Add the content of the blogpost, don't forget the add the data such as date, title, tags, author etc. (see below)
7. Make sure that the image you want to be picked up as header is called header.png and the image you want as a preview must be featured.png
8. Continue with step 5 - 12 of the previous section

#### Adding a blogpost via VS Code
* Choose the right repository 
* Type Git Status in the terminal to check if the develop branch is up to date. Otherwise, git pull.
* Create new branch (title = repository-issue number, for example website-1899), and make sure to continue on this branch
* Check if author is already available otherwise ...
* Create new folder for the blogpost under content > post 
* Name should be the year + month and a title, all lower case with - in between (for example, 2023-02-github-tips)
* In the folder, you should have an index file with all the text, header and featured images, and any additional images used in the blogpost
* Index file: title should be index.md and the template for a blogpost can be used. This includes adding a title, published date, author, tags, etc.
* The image that you want as the header of the blogpost should be named header.png, featured is the image that will appear on the blogpost page. Any additional images used should be lower case with - between words and in the blogpost referred to as ![]./name-of-image
* Save changes and go to the ..
* Check your changes via hugo, otherwise change/save/check again
* Stage the changes
* Git status to check if they are staged on the right branch 
* Git commit -m "message for the commit"
* A PR will come up and lead you to Github where you can create a (draft) PR, ask someone to review, and merge. 



#### Meta data blogpost
---
#widget: pages
#headless: true
title: 'A new interface'
date: "2022-12-28"
lastmod: "2022-12-28"
math: false
diagram: false
summary: "UI updates and new functionalities to improve engagement and navigation"
authors:
- larsson-denise
tags:
- example 1
- example 2


#categories:
#- Demo


featured: false
draft: false
image:
  placement: 1
  preview_only: true
  
---