Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/johnnadratowski/git-reviewers


https://github.com/johnnadratowski/git-reviewers

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README 

        
# git-reviewers



**Tested with python 2.7.12 and 3.5.2 but probably will work with >=2.5**



**Tested with git version 2.11.0**



Wouldn't it be nice if git could give you this output when you have a large PR working with a big team?



![Suggested Reviewers](./doc/img/suggested-reviewers.png)



When working on a large team or in a large company, sometimes its difficult to

tell who you should add as a reviewer to a pull request... especially when

your PR spans multiple files/modules.  Everyone can’t be monitoring for new

PRs all the time, especially across many codebases.



The theory behind this is that if you’re changing a line of code in the vicinity

of what someone has touched, maybe they should be notified of the PR for review.

It accomplishes this by using the `git blame` of the lines around the diff of

a branch.



## Installation



You can easily install the utility by running the following command:



    pip install git+https://github.com/johnnadratowski/git-reviewers.git



## Usage



```

# This will tell you the potential reviewers of the branch, ordered by most prolific, against master

git reviewers -b master



# If you omit -b, it will default first to a `develop` (a la git flow) branch, 

# then to `master` if no `develop` branch exists

git reviewers



# If you only want to see suggested reviewers for certain files:

git reviewers app/test/testfoo.py app/test/testbar.py



# If you want to use this to pipe to another command, 

# you can dump out the raw in-memory data structures as JSON

git reviewers --output=raw



# Specifying a contributer will drop into a ‘diff’ mode, showing you the lines of

# code the contributer has touched in/near your changes

# NOTE: if Pygments is installed, it gives nice syntax highlighting

git reviewers -c “Sally” app/test/testfoo.py app/test/testbar.py

```



## How does it work?



The implementation is really simple, actually.  First, it gets all of the files changed using `git diff --stat`.  Then it will get all of the lines around your changes using `git diff` for each file.  It then splits up the chunks of those ranges to feed to `git blame -L {line numbers}` to get the people who

are familiar with the code.



There are definitely opportunities to improve. Right now it simply counts up the lines, determines the contribution % of each contributer, sorts them, and outputs the information.  However it could be much smarter, and look at what the line of code is doing, or have some weighted value for each type of line depending on what happened in the file.



Also, if you only added files, it has nothing to compare.  In that case it probably makes sense to look at the other files in the module or something else, like the modules that import the new file.



`git-reviewers` gets installed somewhere on `$PATH` so that git can understand `reviewers` as a subcommand.