Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: update reviewbot description #191

Merged
merged 1 commit into from
Jun 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# reviewbot - establish software engineering best practices and efficiently promote them within the organization.
# reviewbot - Comprehensive linters runner for code review scenarios

[![Build Status](https://github.com/qiniu/reviewbot/actions/workflows/go.yml/badge.svg)](https://github.com/qiniu/reviewbot/actions/workflows/go.yml)
[![Go Report Card](https://goreportcard.com/badge/github.com/qiniu/reviewbot)](https://goreportcard.com/report/github.com/qiniu/reviewbot)
[![GitHub release](https://img.shields.io/github/v/tag/qiniu/reviewbot.svg?label=release)](https://github.com/qiniu/reviewbot/releases)

Its ultimate goal is to establish software engineering best practices and efficiently promote them within the organization.

## Why Reviewbot?

Ensuring code quality for a limited number of repositories and languages is not difficult. We just need to use various inspection tools and configure them for the relevant repositories. But what if we are dealing with an entire organization, with different languages, a variety of new and old repositories (300+), and many historical legacy issues? How can we handle that?
Expand Down
4 changes: 3 additions & 1 deletion README_zh.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# reviewbot - establish software engineering best practices and efficiently promote them within the organization.
# reviewbot - Comprehensive linters runner for code review scenarios

[![Build Status](https://github.com/qiniu/reviewbot/actions/workflows/go.yml/badge.svg)](https://github.com/qiniu/reviewbot/actions/workflows/go.yml)
[![Go Report Card](https://goreportcard.com/badge/github.com/qiniu/reviewbot)](https://goreportcard.com/report/github.com/qiniu/reviewbot)
[![GitHub release](https://img.shields.io/github/v/tag/qiniu/reviewbot.svg?label=release)](https://github.com/qiniu/reviewbot/releases)

旨在帮助组织,建立软件工程的最佳实践并有效的推广它们。

## Why Reviewbot?

保障有限数量、有限语言的仓库代码质量是不难的,我们只需要利用各种检查工具给相关的仓库一一配置即可。但如果面临的是整个组织,各种语言,各种新旧仓库(300+),且有很多历史遗留问题,又该如何做呢?
Expand Down
Loading