Skip to content

Commit 134b9b6

Browse files
DouweMclaude
andcommitted
Use GitHub admonition for note in README
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 92560b0 commit 134b9b6

1 file changed

Lines changed: 7 additions & 6 deletions

File tree

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,13 @@
22

33
Extract coding rules from PR review comments and generate `AGENTS.md` files for any GitHub repository.
44

5+
> [!NOTE]
6+
> This project is 100% vibecoded, and the pipeline and thresholds have been optimized for the [`pydantic-ai`](https://github.com/pydantic/pydantic-ai) repo primarily.
7+
>
8+
> If the pipeline generates unexpected rules for your repo, whether invalid or duplicate or otherwise unhelpful, you're encouraged to tell Claude (or your coding agent of choice) to investigate the issue (by referring to the generated rule IDs) and make changes to the pipeline until it does what you want.
9+
>
10+
> It's expected that some teams will use their own fork of `braindump` that evolves over time to meet their needs: there's no expectation that the version in this repo will work for absolutely everyone, so you don't need to upstream changes unless you believe they are strictly better for every user than what came before.
11+
512
## How it works
613

714
```
@@ -54,12 +61,6 @@ export BRAINDUMP_REPO=pydantic/pydantic-ai
5461
uv run braindump run --since 2025-10-01
5562
```
5663

57-
Note that this project is 100% vibecoded, and the pipeline and thresholds have been optimized for the [`pydantic-ai`](https://github.com/pydantic/pydantic-ai) repo primarily.
58-
59-
If the pipeline generates unexpected rules for your repo, whether invalid or duplicate or otherwise unhelpful, you're encouraged to tell Claude (or your coding agent of choice) to investigate the issue (by referring to the generated rule IDs) and make changes to the pipeline until it does what you want.
60-
61-
It's fine and expected if different teams use their own fork of `braindump` that evolves over time to meet their needs: there's no expectation that the version in this repo will work for absolutely everyone, so you don't need to upstream changes unless you believe they are strictly better for every user than what came before.
62-
6364
## Commands
6465

6566
All stages support `--concurrency N` to control parallel LLM/API requests and `--fresh` to wipe previous outputs before running.

0 commit comments

Comments
 (0)