Skip to content

Update tutorial.md #103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update tutorial.md #103

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions docs/tutorial.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ you get started.
Since you're using a code review tool, we'll assume that you have a URL that
you can push to and pull from in order to collaborate with the rest of your team.

First we'll create our local clone of the repository:
First we will create our local clone of the repository:
```shell
git clone ${URL} example-repo
cd example-repo
Expand Down Expand Up @@ -110,7 +110,8 @@ index 08fde78..85c4208 100644

Before a teammate can review our change, we have to make it available to them.
This involves pushing both our commits, and our code review data to the remote
repository:
repository:

```shell
git push
git appraise pull
Expand Down Expand Up @@ -183,7 +184,7 @@ index 08fde78..85c4208 100644
+This is an example repository used for coming up to speed
```

Comments can be added either for the entire review, or on individual lines:
#### Comments can be added either for the entire review, or on individual lines:
```shell
git appraise comment -f README.md -l 2 -m "Ah, so that's what this is" 1e6eb14c8014
```
Expand Down Expand Up @@ -220,7 +221,7 @@ git appraise pull
git appraise push
```

When the change is ready to be merged, you indicate that by accepting the
#### When the change is ready to be merged, you indicate that by accepting the
review:

```shell
Expand Down Expand Up @@ -367,7 +368,7 @@ Date: Wed Dec 16 17:10:06 2015 -0800
...
```

Here you see a linear view of the reviews that have been submitted, but if we
#### Here you see a linear view of the reviews that have been submitted, but if we
run the command `git log --oneline --graph`, then we can see that the full
history of each individual review is also available:

Expand Down