{"id":18510659,"url":"https://github.com/reviewboard/reviewbot","last_synced_at":"2025-05-16T06:04:56.109Z","repository":{"id":2389819,"uuid":"3355797","full_name":"reviewboard/ReviewBot","owner":"reviewboard","description":"A tool for running automated static analysis on code posted to a Review Board instance.","archived":false,"fork":false,"pushed_at":"2025-02-11T18:40:42.000Z","size":2686,"stargazers_count":143,"open_issues_count":1,"forks_count":34,"subscribers_count":16,"default_branch":"master","last_synced_at":"2025-05-09T21:10:39.430Z","etag":null,"topics":["automated-code-review","code-review","python","review-board-extension","reviewboard"],"latest_commit_sha":null,"homepage":"https://www.reviewboard.org/downloads/reviewbot/","language":"Python","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/reviewboard.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2012-02-04T22:20:19.000Z","updated_at":"2025-05-04T15:03:13.000Z","dependencies_parsed_at":"2024-04-10T22:38:40.037Z","dependency_job_id":"b76e3dd4-e327-4133-930c-f67c55c2340f","html_url":"https://github.com/reviewboard/ReviewBot","commit_stats":{"total_commits":349,"total_committers":19,"mean_commits":18.36842105263158,"dds":0.5501432664756447,"last_synced_commit":"f8de550b3ad7e947569ef2a408319c904e56df47"},"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reviewboard%2FReviewBot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reviewboard%2FReviewBot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reviewboard%2FReviewBot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reviewboard%2FReviewBot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/reviewboard","download_url":"https://codeload.github.com/reviewboard/ReviewBot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254478187,"owners_count":22077676,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["automated-code-review","code-review","python","review-board-extension","reviewboard"],"created_at":"2024-11-06T15:24:18.211Z","updated_at":"2025-05-16T06:04:56.084Z","avatar_url":"https://github.com/reviewboard.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"==========\nReview Bot\n==========\n\nWelcome to Review Bot!\n\nReview Bot automates parts of the code review process, using a wide range of\nindustry-standard code checking tools to look over your code and catch\nproblems so your developers can focus on the bigger picture.\n\nIt is:\n\n* **Made for Review Board:** Tools are configured through Review Board's\n  existing Integrations_ functionality, letting you choose exactly when and how\n  tools are run within your organization.\n\n* **Scalable:** Review Bot is built using Celery_ and can scale out to service\n  very large Review Board deployments.\n\n* **Extensible:** Writing plugins is simple using a convenient API to retrieve\n  code files and craft a review. If more power is needed, tools can access the\n  full Review Board API.\n\nPremium support for Review Bot is included with any `Review Board support\ncontract`_.\n\n\n.. _Celery: https://docs.celeryq.dev/\n.. _Integrations: https://www.reviewboard.org/docs/manual/latest/admin/integrations/\n.. _Review Board: https://www.reviewboard.org/\n.. _Review Board support contract: https://www.reviewboard.org/support/\n\n\nSupported Code Checking Tools\n=============================\n\nReview Bot can perform automated code reviews using any of the following\ntools:\n\n\nC/C++\n-----\n\n* `Clang Static Analyzer\n  \u003chttps://www.reviewboard.org/docs/reviewbot/latest/tools/clang/\u003e`_\n  - Compiles and checks C/C++/Objective-C code for a variety of problems\n\n* `Cppcheck\n  \u003chttps://www.reviewboard.org/docs/reviewbot/latest/tools/cppcheck/\u003e`_\n  - Checks C/C++ code for undefined behavior and dangerous coding constructs\n\n* `CppLint \u003chttps://www.reviewboard.org/docs/reviewbot/latest/tools/cpplint/\u003e`_\n  - Checks C++ code against Google's style guide\n\n\nGo\n--\n\n* `gofmt \u003chttps://www.reviewboard.org/docs/reviewbot/latest/tools/gofmt/\u003e`_\n  - Checks Go code for code formatting issues\n\n* `Go Tool \u003chttps://www.reviewboard.org/docs/reviewbot/latest/tools/gotool/\u003e`_\n  - Checks Go code using ``go vet`` and ``go test``\n\n\nJava\n----\n\n* `checkstyle\n  \u003chttps://www.reviewboard.org/docs/reviewbot/latest/tools/checkstyle/\u003e`_\n  - Checks Java code for code formatting issues and code standard\n  inconsistencies\n\n\nJavaScript\n----------\n\n* `JSHint \u003chttps://www.reviewboard.org/docs/reviewbot/latest/tools/jshint/\u003e`_\n  - Checks JavaScript code for common errors\n\n\nPython\n------\n\n* `doc8 \u003chttps://www.reviewboard.org/docs/reviewbot/latest/tools/doc8/\u003e`_\n  - Check ReStructuredText documentation for styling and syntax errors\n\n* `flake8 \u003chttps://www.reviewboard.org/docs/reviewbot/latest/tools/flake8/\u003e`_\n  - Checks Python code using a variety of common code Python quality tools\n\n* `pycodestyle\n  \u003chttps://www.reviewboard.org/docs/reviewbot/latest/tools/pycodestyle/\u003e`_\n  - Checks Python code for code formatting issues\n\n* `pydocstyle\n  \u003chttps://www.reviewboard.org/docs/reviewbot/latest/tools/pydocstyle/\u003e`_\n  - Checks Python docstrings for errors and common formatting issues\n\n* `pyflakes\n  \u003chttps://www.reviewboard.org/docs/reviewbot/latest/tools/pyflakes/\u003e`_\n  - Checks Python code for missing imports, unused or undefined variables or\n  functions, and more\n\n\nRuby\n----\n\n* `RuboCop\n  \u003chttps://www.reviewboard.org/docs/reviewbot/latest/tools/rubocop/\u003e`_\n  - Checks Ruby code for common code formatting issues\n\n\nRust\n----\n\n* `Cargo Tool\n  \u003chttps://www.reviewboard.org/docs/reviewbot/latest/tools/cargotool/\u003e`_\n  - Checks Rust code for errors and suspicious constructs\n\n* `rustfmt\n  \u003chttps://www.reviewboard.org/docs/reviewbot/latest/tools/rustfmt/\u003e`_\n  - Checks Rust code for code formatting issues based on the automatic\n  formatting rules in ``rustfmt``\n\n\nShell Scripts\n-------------\n\n* `ShellCheck\n  \u003chttps://www.reviewboard.org/docs/reviewbot/latest/tools/shellcheck/\u003e`_\n  - Checks Bash/sh scripts for common problems and misused commands\n\n\nMulti-Language Tools\n--------------------\n\n* `FBInfer\n  \u003chttps://www.reviewboard.org/docs/reviewbot/latest/tools/fbinfer/\u003e`_\n  - Checks a wide range of programming languages for potential errors\n\n* `PMD \u003chttps://www.reviewboard.org/docs/reviewbot/latest/tools/pmd/\u003e`_\n  - Checks code in a variety of programming languages for syntax errors and\n  other problems\n\n* `Secret Scanner\n  \u003chttps://www.reviewboard.org/docs/reviewbot/latest/tools/rbsecretscanner/\u003e`_\n  - Checks source code and configuration files for accidental inclusion of\n  sensitive keys and credentials\n\nSee the links above for installation and usage instructions.\n\n\nInstalling Review Bot\n=====================\n\nReview Bot is made up of a message broker, at least one `Review Bot worker`_,\nthe `Review Bot extension`_ for Review Board, and various code checking tools.\n\n`Official Docker images`_ are also available.\n\nSee the `downloads page`_ and read the `Review Bot documentation`_ to learn\nhow to install and configure Review Bot and its components.\n\n\n.. _downloads page: https://www.reviewboard.org/downloads/reviewbot/\n.. _Official Docker images:\n   https://www.reviewboard.org/docs/reviewbot/latest/installation/docker/\n.. _Review Bot documentation:\n   https://www.reviewboard.org/docs/reviewbot/latest/\n.. _Review Bot extension: https://pypi.org/project/reviewbot-extension/\n.. _Review Bot worker: https://pypi.org/project/reviewbot-worker/\n\n\nGetting Support\n===============\n\nWe can help you get going with Review Bot, and diagnose any issues that may\ncome up. There are three levels of support: Public Community Support, Private\nBasic Support, and Private Premium Support.\n\nThe public community support is available on our main `discussion list`_. We\ngenerally respond to requests within a couple of days. This support works well\nfor general, non-urgent questions that don't need to expose confidential\ninformation.\n\nPrivate Support plans are available through support contracts. We offer\nsame-day support options, handled confidentially over e-mail or our support\ntracker, and can assist with a wide range of requests.\n\nSee your `support options`_ for more information.\n\n\n.. _discussion list: https://groups.google.com/group/reviewboard/\n.. _support options: https://www.reviewboard.org/support/\n\n\nReporting Bugs\n==============\n\nHit a bug? Let us know by\n`filing a bug report \u003chttps://www.reviewboard.org/bugs/new/\u003e`_.\n\nYou can also look through the\n`existing bug reports \u003chttps://www.reviewboard.org/bugs/\u003e`_ to see if anyone\nelse has already filed the bug.\n\nIf you have a `Review Board support contract`_, feel free to reach out to us\nfor any support issues.\n\n\nContributing\n============\n\nAre you a developer? Do you want to help build new tools or features for\nReview Bot? Great! Let's help you get started.\n\nFirst off, read through our `Contributor Guide`_.\n\nWe accept patches to Review Bot, Review Board, RBTools, and other related\nprojects on `reviews.reviewboard.org \u003chttps://reviews.reviewboard.org/\u003e`_.\n(Please note that we *do not* accept pull requests.)\n\nGot any questions about anything related to Review Board and development? Head\non over to our `development discussion list`_.\n\n.. _`Contributor Guide`: https://www.reviewboard.org/docs/codebase/dev/\n.. _`development discussion list`:\n   https://groups.google.com/group/reviewboard-dev/\n\n\nRelated Projects\n================\n\n* `Review Board`_ -\n  Our extensible, open source code review tool.\n* RBTools_ -\n  The RBTools command line suite.\n* `RB Gateway`_ -\n  Manages Git repositories, providing a full API enabling all of Review Board's\n  feaures.\n\n.. _RBTools: https://github.com/reviewboard/rbtools/\n.. _ReviewBot: https://github.com/reviewboard/ReviewBot/\n.. _RB Gateway: https://github.com/reviewboard/rb-gateway/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freviewboard%2Freviewbot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freviewboard%2Freviewbot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freviewboard%2Freviewbot/lists"}