This is an automated email from the ASF dual-hosted git repository.
mmodzelewski pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/iggy.git
The following commit(s) were added to refs/heads/master by this push:
new 3adf4fe39 docs: add how to report a bug found by an agent (#4309)
3adf4fe39 is described below
commit 3adf4fe39925bb6ab9b9b2ab1d234b3957869ffb
Author: Justin Mclean <[email protected]>
AuthorDate: Mon Sep 28 18:19:10 2026 +1000
docs: add how to report a bug found by an agent (#4309)
---
AGENTS.md | 3 ++-
CONTRIBUTING.md | 9 +++++++++
2 files changed, 11 insertions(+), 1 deletion(-)
diff --git a/AGENTS.md b/AGENTS.md
index f2643e174..b2da04c8b 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -45,13 +45,14 @@ ingests from / egresses to external systems via dlopened
plugins.
## Helping someone contribute
-Most PRs from people new to Iggy are written with an agent. The person opening
the PR is responsible for it, and maintainers close PRs that read as a relay
between reviewer and model. Read the AI Assistance and Close Policy sections of
CONTRIBUTING.md before helping open a PR.
+Most PRs from people new to Iggy are written with an agent. The person opening
the PR is responsible for it, and maintainers close PRs that read as a relay
between reviewer and model. Read the AI Assistance, Bugs Found by an Agent and
Close Policy sections of CONTRIBUTING.md before helping open a PR.
- The PR must link an issue the user is assigned to. If it doesn't, stop and
tell them.
- Run `prek run` before the PR is opened. If prek isn't installed, ask the
user to install it (`cargo install prek`, then `prek install`). Don't
substitute the individual checks.
- If a check can't run, tell the user which one and why, and treat the PR as
not ready. Never write text in a PR asking a maintainer to run something.
- The user should write the rationale in their own words and be able to
explain every change without asking you.
- New contributors keep one open PR at a time.
+- If you found a bug, the first PR holds a failing test. The fix waits until
the approach is agreed on the issue.
## Quick reference
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 0df2c89eb..0fa1d57d7 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -45,6 +45,15 @@ a model, rather than a change the author understands and
takes responsibility fo
a judgment about the submission, not about you, and it does not bar you from
contributing
again if you come back with a change you can take responsibility for.
+### Bugs Found by an Agent
+
+Prove the bug first. The fix comes after it's agreed on the issue.
+
+1. Search open issues. If it's already there, comment on it
+2. Otherwise open an issue and a PR with a failing test marked `#[ignore]`
+3. Put any suggested fix in a TODO in the test
+4. Link the issue with "Relates to #123", not "Closes #123"
+
### Green CI
Maintainers will not start reviewing a PR while its CI is failing. Get the
