Skip to content
This repository was archived by the owner on Aug 16, 2025. It is now read-only.

Commit 3d47fa9

Browse files
buf docs
1 parent fe93192 commit 3d47fa9

File tree

2 files changed

+35
-0
lines changed

2 files changed

+35
-0
lines changed

‎docs/tools/buf.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
title: Buf
3+
sidebar_label: Buf
4+
description: CodeRabbit's guide to Buf.
5+
---
6+
7+
[Buf](https://buf.build/) offers linting for Protobuf files.
8+
9+
## Files
10+
11+
Buf will run on files with the following extensions:
12+
13+
-`.proto`
14+
15+
## Configuration
16+
17+
Buf uses a YAML style configuration file. We look for the following file anywhere in the repository:
18+
19+
-`buf.yaml`
20+
21+
If no config file is found, CodeRabbit will consider the following categories of strictness based on the profile selected:
22+
23+
### Chill
24+
25+
-`MINIMAL`
26+
27+
### Assertive
28+
29+
-`BASIC`
30+
31+
## Links
32+
33+
-[Buf Configuration](https://buf.build/docs/configuration/v2/buf-yaml#lint)

‎docs/tools/tools.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ Remove extraneous f prefix
6060
| Typescript |[Biome][Biome]|
6161
| YAML |[YamlLint][YamlLint]|
6262
| Ruby |[Rubocop][Rubocop]|
63+
| Buf |[Buf][Buf]|
6364

6465
[ShellCheck]: ./shellcheck.md
6566
[Ruff]: ./ruff.md
@@ -75,3 +76,4 @@ Remove extraneous f prefix
7576
[Checkov]: ./checkov.md
7677
[Detekt]: ./detekt.md
7778
[Rubocop]: ./rubocop.md
79+
[Buf]: ./buf.md

0 commit comments

Comments
(0)