Skip to content

Commit

Permalink
docs: fix markup errors
Browse files Browse the repository at this point in the history
  • Loading branch information
ThomasWaldmann committed Jan 14, 2024
1 parent 438f1dd commit 576ee35
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -170,13 +174,15 @@ 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

Then, update the local ``master`` branch with changes made in the upstream
repository.
::

git pull borg master

Rebase feature branch onto updated master branch
Expand All @@ -185,13 +191,15 @@ 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

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
Expand Down

0 comments on commit 576ee35

Please sign in to comment.