Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/albertyw/git-reviewers
Intelligently find code reviewers
https://github.com/albertyw/git-reviewers
cli code-review git git-review hacktoberfest python python-3 reviewer
Last synced: 2 months ago
JSON representation
Intelligently find code reviewers
- Host: GitHub
- URL: https://github.com/albertyw/git-reviewers
- Owner: albertyw
- License: mit
- Created: 2017-06-05T06:13:51.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-04-24T06:10:54.000Z (8 months ago)
- Last Synced: 2024-04-24T10:28:51.682Z (8 months ago)
- Topics: cli, code-review, git, git-review, hacktoberfest, python, python-3, reviewer
- Language: Python
- Homepage:
- Size: 149 KB
- Stars: 14
- Watchers: 3
- Forks: 4
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
git-reviewers
=============
[](https://pypi.org/project/git-reviewers/)
[](https://pypi.org/project/git-reviewers/)
[](https://drone.albertyw.com/albertyw/git-reviewers)
[](https://codeclimate.com/github/albertyw/git-reviewers/maintainability)
[](https://codeclimate.com/github/albertyw/git-reviewers/test_coverage)
Intelligently find code reviewers.
See also, [git-browse](https://github.com/albertyw/git-browse).
Installation
------------
### Homebrew (preferred for MacOS)
If you use Homebrew, you can install git-reviewers through the
[homebrew-albertyw tap](https://github.com/albertyw/homebrew-albertyw):
```bash
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](https://github.com/albertyw/dotfiles)
repository), then run `/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
-b BASE_BRANCH, --base-branch BASE_BRANCH
Compare against a base branch (default: master)
```
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
- `FindHistoricalReviewers` - Generate reviewers based on the repository
committers as a whole
- `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):
```json
{
"verbose": false,
"copy": false,
"ignore": ["a", "b", "c"],
"base_branch": "master"
}
```
`git-reviewers` will also by default search for and load a json
configuration file at `~/.git/reviewers`.
Development
-----------
```bash
pip install -e .[test]
ruff check .
mypy .
coverage run -m unittest
coverage report -m
```
Publishing
----------
```bash
pip install twine
python -m build
twine upload dist/*
```
Need to also update [albertyw/homebrew-albertyw](https://github.com/albertyw/homebrew-albertyw).