Suggest reviewers for your git branch
Project description
Intelligently find code reviewers. See also, git-browse.
Installation
Homebrew (preferred for MacOS)
If you use Homebrew, you can install git-reviewers through the homebrew-albertyw tap:
brew install albertyw/albertyw/git-reviewers
Manual
If you don’t use Homebrew, first clone this repository to somewhere on your system (perhaps in your dotfiles repository), then run <REPOSITORY_LOCATION>/install.sh.
After installation, you can modify any default flags for git-reviewers in ~/.gitconfig
Usage
usage: reviewers.py [-h] [-v] [--verbose] [-i IGNORE] [-j JSON] [-c] Suggest reviewers for your diff. https://github.com/albertyw/git-reviewers optional arguments: -h, --help show this help message and exit -v, --version show program's version number and exit --verbose verbose mode -i IGNORE, --ignore IGNORE ignore a list of reviewers (comma separated) -j JSON, --json JSON json file to read configs from, overridden by CLI flags -c, --copy Copy the list of reviewers to clipboard, if available
Finders
git-reviewers is componsed of a set of strategies for generating lists of reviewers, or Finders. They return a weighted set of reviewers which is then sorted and recommended to you. They include:
FindLogReviewers - Generate a list of reviewers based on committers to your committed (but not merged with master) files
FindArcCommitReviewers - Generate reviewers based on arc commit messages for files which you have modified on your branch
Configuration
git-reviewers supports reading configuration from a configuration file with the --json flag. The configuration file accepts json with the following fields (all fields optional):
{
"verbose": False,
"copy": False,
"ignore": ["a", "b", "c"]
}
git-reviewers will also by default search for and load a json configuration file at ~/.git/reviewers.
Development
pip install -r requirements-test.txt
coverage run setup.py test
coverage report
flake8
Publishing
pip install twine
python setup.py sdist bdist_wheel
twine upload dist/*
Need to also update albertyw/homebrew-albertyw
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for git_reviewers-0.12.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | aa97af02888eab8ab23bc0d518e58a3ab839e1906b79d154b7c0fd2f04c24f9b |
|
MD5 | 4395135f5abf5dbedf4bb920e121010b |
|
BLAKE2b-256 | 8a1f7c99cd97c6f2a2a7ea6c4cb60b15680bc51dfcbb9338fdca5d4a0c1beb3e |