docs: fix markup errors

This commit is contained in:
Thomas Waldmann 2024-01-14 17:27:21 +01:00
parent 438f1ddef7
commit 576ee3532c
No known key found for this signature in database
GPG Key ID: 243ACFA951F78E01
1 changed files with 8 additions and 0 deletions

View File

@ -127,6 +127,7 @@ e.g. 1.4.x).
Start by checking out the appropriate branch:
::
git checkout master
It is best practice for a developer to keep local ``master`` branch as an
@ -140,16 +141,19 @@ only to ``master``.
Thus, create a new branch now:
::
git checkout -b MYCONTRIB-master # choose an appropriate own branch name
Now, work on your contribution in that branch. Use these git commands:
::
git status # is there anything that needs to be added?
git add ... # if so, add it
git commit # finally, commit it. use a descriptive comment.
Then push the changes to your Github repository:
::
git push --set-upstream origin MYCONTRIB-master
Finally, make a pull request on ``borgbackup/borg`` Github repository against
@ -170,6 +174,7 @@ Next, check out the ``master`` branch again. Find the commit hash of the last
commit that was made before you started working on your contribution and perform
a hard reset.
::
git checkout master
git log
git reset --hard THATHASH
@ -177,6 +182,7 @@ a hard reset.
Then, update the local ``master`` branch with changes made in the upstream
repository.
::
git pull borg master
Rebase feature branch onto updated master branch
@ -185,6 +191,7 @@ Rebase feature branch onto updated master branch
After updating the local ``master`` branch from upstream, the feature branch
can be checked out and rebased onto (the now uptodate) ``master`` branch.
::
git checkout MYCONTRIB-master
git rebase -i master
@ -192,6 +199,7 @@ Next, check if there are any commits that exist in the feature branch
but not in the ``master`` branch and vice versa. If there are no
conflicts or after resolving them, push your changes to your Github repository.
::
git log
git diff master
git push -f