github-review: GitHub code reviews with Emacs.

This package contains a handful of Emacs commands to review GitHub pull request without leaving Emacs.

To get an overview of the package you can watch this 4-minute video:

You can start by calling github-review-start and entering a Pull Request URL. You will, then be prompted with a buffer containing the diff of the pull request. The diff contains the description of the PR at the top with line starting with ~. For example, reviewing this pull request would open the following buffer:

~ Fix broken link to closure cheat sheet
~
~ The owner of http://www.closurecheatsheet.com/ lost the domain and does not intend to maintain it. This commit replaces the now defunkt link to http://www.closurecheat$
~ ^M
~ I also opened an issue on the cheat sheet repo to follow up with the author of the cheat sheet https://github.com/kuzmisin/closurecheatsheet/issues/12.
diff --git a/content/reference/google-closure-library.adoc b/content/reference/google-closure-library.adoc
index 58baa4b..eae7707 100644
--- a/content/reference/google-closure-library.adoc
+++ b/content/reference/google-closure-library.adoc
@@ -18,7 +18,7 @@ rich-text editing, and UI widgets/controls.

 * http://google.github.io/closure-library/api/[Google Closure Library
 API Reference]
-* http://www.closurecheatsheet.com/[Closure Cheatsheet] - abridged API
+* https://github.com/kuzmisin/closurecheatsheet[Closure Cheatsheet] - abridged API
 with usage examples

 [[try-the-wrapper-libraries-first]]

You can add comments at the top-level by writing lines starting with # after the PR description and before the beginning of the diff.

You can add comments inline by adding lines starting with # inline. See these features in the example below:

~ Fix broken link to closure cheat sheet
~
~ The owner of http://www.closurecheatsheet.com/ lost the domain and does not intend to maintain it. This commit replaces the now defunkt link to http://www.closurecheat$
~ ^M
~ I also opened an issue on the cheat sheet repo to follow up with the author of
the cheat sheet https://github.com/kuzmisin/closurecheatsheet/issues/12.
# This is a global comment at the top of the file
# with multiple
# lines and will be submitted as a top level review comment
diff --git a/content/reference/google-closure-library.adoc b/content/reference/google-closure-library.adoc
index 58baa4b..eae7707 100644
--- a/content/reference/google-closure-library.adoc
+++ b/content/reference/google-closure-library.adoc
@@ -18,7 +18,7 @@ rich-text editing, and UI widgets/controls.

 * http://google.github.io/closure-library/api/[Google Closure Library
 API Reference]
-* http://www.closurecheatsheet.com/[Closure Cheatsheet] - abridged API
+* https://github.com/kuzmisin/closurecheatsheet[Closure Cheatsheet] - abridged API
# And a comment inline about
# a specific line
# ```with some
# code```
  with usage examples
# Some other comment inline
 with usage examples

 [[try-the-wrapper-libraries-first]]

Once done, you can submit your review with one of github-review-approve, github-review-comment, and github-review-reject.

Usage with Forge

You can use github-review with forge. When your cursor is over a pull request, you can call github-review-forge-pr-at-point to start a code review.

Installation

With melpa

This is the preferred way of installing this package.

With doom emacs

github-review gets installed automatically if you are using the magit module.

If you just want to install github-review separately, add the following to your config:

(package!
 github-review
 :recipe
    (:host github
     :repo "charignon/github-review"
     :files ("github-review.el")))

Configuration

GitHub

github-review needs a GitHub token to act on your behalf for fetching PRs and submitting reviews.

1. Create a personal access token using GitHub
2. Set the repo scope as the subscope of repo
3. If using GitHub enterprise / for business you also need the write:discussion read:discussion scope.

Auth

Add a line to your auth source files with your login and token:

machine api.github.com login yourlogin^github-review password MYTOKENGOESHERE

Customization

If you use GitHub Enterprise, you can use the github-review-host custom variable to configure the endpoint of your GitHub Enterprise installation, this should look like api.git.mycompany.com.

• By default, github-review fetches only top level comments in a pull request. You can set github-review-view-comments-in-code-lines to t to also fetch comments made between code lines.

  You can also enable comments between code lines that are outdated by setting github-review-view-comments-in-code-lines-outdated to t, however we cannot guarantee correct placement of these comments in the review buffer.

  You can also enable replies to inline comments by setting github-review-reply-inline-comments to t, this feature only works if github-review-view-comments-in-code-lines is also set to t. This way, if you include a comment right after a previous received comment in the diff buffer, your new comment will be sent as a reply.

Notice

I am providing code in the repository to you under an open source license. Because this is my personal repository, the license you receive to my code is from me and not my employer (Facebook)