<commit_before># Diffscuss: Code Reviews.  In Plain Text.

## What is Diffscuss?

Diffscuss is:

* a file format, built on the the unified diff format, that allows
  threaded code reviews to exist inline with the diffs they address

* an Emacs mode and Vim plugin to support responding to / managing
  code reviews in that format (including jumping directly to the
  source code a comment addresses)

* a set of command line tools to support generating and managing
  reviews in the diffscuss format with a simple, directory based tool
  for posting and managing code reviews

We at Hut 8 Labs originally developed diffscuss to help us do code
reviews when we were onsite with a client who didn't have their own
code review system.  We found ourselves emailing diffs back and forth,
writing things like "about halfway through the diff you do X, maybe
you should do Y?"  Eventually we started writing comments right in the
diffs themselves, with markers like "EWJ REVIEW!!!" and thought "There
has to be a better way."

Now, about 6 months into using diffscuss, we've grown to love its
support for code reviews in our editors--where we're already efficient
at reading and navigating code--and especially its abililty to jump
directly from a comment to the corresponding line of actual source,
which lowers the activation energy for addressing reviews and actually
making all those little suggested improvements.

## What Does a Diffscuss Review Look Like?

Screenshot of a Diffscuss review in Emacs:

![Emacs Screenshot](doc/diffscuss-reading-review.png)

After jumping to source:

![Emacs Screenshot](doc/diffscuss-jump-to-source.png)

## Why Might You Want to Use Diffscuss?

* you like the idea of reading and responding to code reviews right in
  your editor

* you want to lower the activation energy needed to apply small fixes
  and suggestions (jump right to the source with a single key combo!
  make the change!  jump right back!)

* you like the idea of keeping your reviews in your repo, right next
  to your code, or emailing them back and forth if you're just a
  couple hackers working on something and that's easier<commit_msg>Use full path for images to ease pages generation.<commit_after># Diffscuss: Code Reviews.  In Plain Text.

## What is Diffscuss?

Diffscuss is:

* a file format, built on the the unified diff format, that allows
  threaded code reviews to exist inline with the diffs they address

* an Emacs mode and Vim plugin to support responding to / managing
  code reviews in that format (including jumping directly to the
  source code a comment addresses)

* a set of command line tools to support generating and managing
  reviews in the diffscuss format with a simple, directory based tool
  for posting and managing code reviews

We at Hut 8 Labs originally developed diffscuss to help us do code
reviews when we were onsite with a client who didn't have their own
code review system.  We found ourselves emailing diffs back and forth,
writing things like "about halfway through the diff you do X, maybe
you should do Y?"  Eventually we started writing comments right in the
diffs themselves, with markers like "EWJ REVIEW!!!" and thought "There
has to be a better way."

Now, about 6 months into using diffscuss, we've grown to love its
support for code reviews in our editors--where we're already efficient
at reading and navigating code--and especially its abililty to jump
directly from a comment to the corresponding line of actual source,
which lowers the activation energy for addressing reviews and actually
making all those little suggested improvements.

## What Does a Diffscuss Review Look Like?

Screenshot of a Diffscuss review in Emacs:

![Emacs Screenshot](https://github.com/hut8labs/diffscuss/blob/master/doc/diffscuss-reading-review.png?raw=true)

After jumping to source:

![Emacs Screenshot](https://github.com/hut8labs/diffscuss/blob/master/doc/diffscuss-jump-to-source.png?raw=true)

## Why Might You Want to Use Diffscuss?

* you like the idea of reading and responding to code reviews right in
  your editor

* you want to lower the activation energy needed to apply small fixes
  and suggestions (jump right to the source with a single key combo!
  make the change!  jump right back!)

* you like the idea of keeping your reviews in your repo, right next
  to your code, or emailing them back and forth if you're just a
  couple hackers working on something and that's easier
{'fraction_non_alphanumeric': 0.043478260869565216, 'fraction_numerical': 0.0013516557783284523, 'mean_word_length': 4.36231884057971, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 2, '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': '2030915', 'n_tokens_mistral': 1171, 'n_tokens_neox': 1128, 'n_words': 673}