summaryrefslogtreecommitdiff
path: root/contributors/guide/github-workflow.md
diff options
context:
space:
mode:
authorKubernetes Prow Robot <k8s-ci-robot@users.noreply.github.com>2019-10-14 08:30:37 -0700
committerGitHub <noreply@github.com>2019-10-14 08:30:37 -0700
commitbfe4844bcd0a284b9522bb7579d1bb1cb31fde3e (patch)
tree5b4ad916f8b2a01bfe40ae2778d46a9805e69e8e /contributors/guide/github-workflow.md
parentc556919b65e5bc7980443d6012f1b51b7ce6b9b8 (diff)
parent463f51476fdc1147a90a97179ea9fd1d912ddf65 (diff)
Merge pull request #4155 from mrbobbytables/fix-markdown-formatting
Update contributor guide formatting to be Hugo compatible.
Diffstat (limited to 'contributors/guide/github-workflow.md')
-rw-r--r--contributors/guide/github-workflow.md47
1 files changed, 22 insertions, 25 deletions
diff --git a/contributors/guide/github-workflow.md b/contributors/guide/github-workflow.md
index 8174aaf8..1963b206 100644
--- a/contributors/guide/github-workflow.md
+++ b/contributors/guide/github-workflow.md
@@ -1,7 +1,7 @@
---
title: "GitHub Workflow"
weight: 1
-slug: "github"
+slug: "github-workflow"
---
![Git workflow](git_workflow.png)
@@ -173,38 +173,35 @@ _If you have upstream write access_, please refrain from using the
`Revert` button in the GitHub UI for creating the PR, because GitHub
will create the PR branch inside the main repository rather than inside your fork.
-1. Create a branch and sync it with upstream.
+- Create a branch and sync it with upstream.
-```sh
-# create a branch
-git checkout -b myrevert
-
-# sync the branch with upstream
-git fetch upstream
-git rebase upstream/master
-```
+ ```sh
+ # create a branch
+ git checkout -b myrevert
-2. If the commit you wish to revert is a:
+ # sync the branch with upstream
+ git fetch upstream
+ git rebase upstream/master
+ ```
+- If the commit you wish to revert is a:<br>
+ - **merge commit:**
-- merge commit:
+ ```sh
+ # SHA is the hash of the merge commit you wish to revert
+ git revert -m 1 SHA
+ ```
-```sh
-# SHA is the hash of the merge commit you wish to revert
-git revert -m 1 SHA
-```
-
-- single commit:
+ - **single commit:**
-```sh
-# SHA is the hash of the single commit you wish to revert
-git revert SHA
-```
+ ```sh
+ # SHA is the hash of the single commit you wish to revert
+ git revert SHA
+ ```
-3. This will create a new commit reverting the changes.
-Push this new commit to your remote.
+- This will create a new commit reverting the changes. Push this new commit to your remote.
```sh
git push ${your_remote_name} myrevert
```
-4. [Create a Pull Request](#7-create-a-pull-request) using this branch.
+- [Create a Pull Request](#7-create-a-pull-request) using this branch. \ No newline at end of file