mx/MX_Pmodule
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
assman_g
2024-03-14 16:45:49 +01:00
parent ba12fe41e7
commit abca67b1bd
1 changed files with 12 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@@ -10,7 +10,7 @@ Documentation for how-to-build modules can be found in: https://pmodules.gitpage
## Examples for Editing Readme
- [ ] [writing bulletpoints]
- [ ] [write a bulletpoints with a link](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [write a bulletpoint with a link](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
```
This is a code block example
@@ -22,15 +22,20 @@ This is a code block example
Please follow the below steps to add content to the Repo. The main branch is a proteced branch, which is why you need/want to follow the steps below. If something is unclear, dont hesitate to ask Kate or Greta.
- [ ] [In the Terminal: git clone the repo/ git pull to ensure you have the latest changes]
- [ ] [On the Repo Webpage: cick on "Issues" (left side) and create a "New issue" ]
- [ ] [<strong>In the Terminal</strong>: git clone the repo/ git pull to ensure you have the latest changes]
- [ ] [<strong>On the Repo Webpage</strong>: cick on "Issues" (left side) and create a "New issue" ]
- [ ] [--> add a title for the issue and add a description if you want]
- [ ] [--> click on "Create Merge Request". It will autmatically refer to the issue that you openend and will close this issue if the MR is accepted. It will also delete the created branch after the MR is accepted if the box is checked (usually default)]
- [ ] [--> The merge request will be created and will be in a state "Draft"]
- [ ] [In the Terminal: git pull again, as a new branch was created with the opened Merge request]
- [ ] [--> git checkout 'new_branch_name']
- [ ] [<strong>In the Terminal</strong>: git pull again, as a new branch was created with the opened Merge request]
- [ ] [--> git checkout 'new_branch_name'(you can see the name of the branch with git branch -r , starting with the number of your issue)]
- [ ] [--> git status , check you are on the new branch]
- [ ] [In the Terminal: git pull again, as a new branch was created with the opened Merge request]
- [ ] [In the Terminal: git pull again, as a new branch was created with the opened Merge request]
- [ ] [--> on the new branch, edit your files]
- [ ] [--> git add . (add all edited files)]
- [ ] [--> git commit -m "add commit message"]
- [ ] [--> git push (it will push to the new branch]
- [ ] [<strong>On the Repo Webpage</strong>: open the MR , and change the status to "Mark as Ready" ]
- [ ] [--> the merge request can be actively merged (can also be assigned to other people to check/approve) ]
- [ ] [--> the issue/MR and branch should be deleted on the Repo. For further work, make sure to git checkout to main/next new branch etc.. ]