<commit_before># git-review

Bare-bones code review with GIT tags.

## Example Workflow for Requesting a Review

Create a topic branch and make some changes to your code.

```sh
git checkout -b topic-a
git commit -a -m "Some changes regarding Topic A."
```

Request a review with an optional comment and review id.

```sh
git review [-a | -m <comment>] -i
```

Or

```sh
git review [-a | -m <comment>] <id> [<ref>]
```

List reviews and replies.

```sh
git review [-n] [-l <id>]
```

Reply to a review.

```sh
git review -r [-m <comment>] <id>
```

Close a review.

```sh
git review -c [-a | -m <comment>] <id>
```<commit_msg>Updated readme with installation instructions<commit_after># git-review

Bare-bones code review with GIT tags.

## Installation

Run this in your terminal:

```sh
(cd /usr/local/bin && curl -#SLOf https://raw.github.com/icetan/git-review/master/git-review && chmod +x git-review)
```

NOTE: To change the installation path change `/usr/local/bin` to any other
directory which is in your `$PATH`.

## Usage

Request a review with an optional comment and review id.

```sh
git review [-a | -m <comment>] -i
```

Or

```sh
git review [-a | -m <comment>] <id> [<ref>]
```

List reviews and replies.

```sh
git review [-n] [-l <id>]
```

Reply to a review.

```sh
git review -r [-m <comment>] <id>
```

Close a review.

```sh
git review -c [-a | -m <comment>] <id>
```

## Example review request workflow

Create a topic branch and make some changes to your code:

```sh
git checkout -b topic-a
git commit -a -m "Some changes regarding Topic A."
```

Submit a review request for that branch:

```sh
git review -i
```

This will create a new `review-x` tag that is pushed to the remote repo, `x`
will be a unique review id.

Alternatively set a review name:

```sh
git review topic-a
```

## Example code review workflow

Check to see if any reviews are pending:

```sh
git review -n
```

Select a review of interest and show a diff between the tagged commit and the
`master` branch. Let's say you want to review number `36`.

The GIT tag name is the review number with `review-` in front of it.

```sh
git diff master...review-36
```

Reply with comments about the code:

```sh
git review -r -m"Needs moar pasta." 36
```

Wait for a reply or a new commit and repeat the last step until you are
satisfied with the fixes.

Now you can close the review to hide it from the pending list. An optional
comment can be submitted with `-m`.

```sh
git review -c 36
```
{'fraction_non_alphanumeric': 0.1338709677419355, 'fraction_numerical': 0.0032258064516129032, 'mean_word_length': 3.446236559139785, 'pattern_counts': {'":': 0, '<': 21, '<?xml version=': 0, '>': 21, 'https://': 1, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4242477', 'n_tokens_mistral': 873, 'n_tokens_neox': 796, 'n_words': 389}