Skip to content

Commit

Permalink
docs: add features show
Browse files Browse the repository at this point in the history
  • Loading branch information
CarlJi committed Jan 22, 2024
1 parent 9c328a3 commit a5003f5
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
[![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?

Thank for the community, there is a wide range of lint tools available for almost every programming language. However, many of these tools rely on a command-line interface (CLI) and require configuring jobs in CI systems like Github Action, Travis, and others. While this is typically manageable, it can become tedious when dealing with a large number of repositories that need to be configured.

Expand All @@ -13,8 +14,32 @@ Furthermore, traditional CI errors are often only displayed in the console, nece

In such scenarios, reviewbot is an ideal service to consider. It allows you to set up your own service that can receive events from GitHub and automatically perform various linting checks, providing precise feedback on specific lines of code that require attention. Enjoy the benefits of safety, customization, and powerful linting capabilities.

![Alt text](docs/static/staticcheck.png)

Please note that reviewbot is still in its early stages, and we have plans to integrate more lint tools and support additional code hosting platforms such as GitLab. We are also exploring the possibility of incorporating AI for code review purposes.

Lastly, we welcome any contributions to the project! Your bug reports, feature suggestions, and active participation in the development process are greatly appreciated. Together, we can make reviewbot even better.

![Alt text](docs/static/image.png)
## Features

<details open>
<summary><b>Linters for the Go programming language</b></summary>
<br>


- [staticcheck](internal/linters/go/staticcheck)
> As above
<br>
</details>

<details open>
<summary><b>Linters for git flow interactions</b></summary>
<br>


- [rebase suggestion](internal/linters/git-flow/rebase-suggestion)
> ![rebase-suggestion](docs/static/rebase-suggestion.jpg)
<br>
</details>
Binary file added docs/static/rebase-suggestion.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes

0 comments on commit a5003f5

Please sign in to comment.