Skip to content

[MINOR][DOCS] Clarify when to ask the user before running tests in AGENTS.md#55685

Closed
cloud-fan wants to merge 1 commit into
apache:masterfrom
cloud-fan:minor-agents-md-test-prompt
Closed

[MINOR][DOCS] Clarify when to ask the user before running tests in AGENTS.md#55685
cloud-fan wants to merge 1 commit into
apache:masterfrom
cloud-fan:minor-agents-md-test-prompt

Conversation

@cloud-fan
Copy link
Copy Markdown
Contributor

What changes were proposed in this pull request?

Tighten the wording in AGENTS.md that tells coding agents to ask the user about pending changes before running tests. The previous wording fired even when the user explicitly asked for a test run.

Before:

Build and tests can take a long time. Before running tests, ask the user if they have more changes to make.

After:

Build and tests can take a long time. If the user explicitly asked to run tests, run them. Otherwise (you are running tests on your own to verify a change), first ask the user if they have more changes to make.

Why are the changes needed?

The intent of the original instruction was to avoid kicking off a long, agent-initiated test run when the user has more edits coming. But as written, it also applies when the user explicitly requests a test run, which makes the prompt redundant and annoying. Spelling out both branches makes it easier for LLMs to follow the rule correctly.

Does this PR introduce any user-facing change?

No. Documentation-only update for coding agent instructions.

How was this patch tested?

N/A — documentation only.

Was this patch authored or co-authored using generative AI tooling?

Generated-by: Claude Code (Claude Opus 4.7)

@cloud-fan
Copy link
Copy Markdown
Contributor Author

thanks for the review, merging to master/4.x/4.2 (as branch 4.2 is still active before RC cut)

@cloud-fan cloud-fan closed this in feab925 May 6, 2026
cloud-fan added a commit that referenced this pull request May 6, 2026
…ENTS.md

### What changes were proposed in this pull request?

Tighten the wording in `AGENTS.md` that tells coding agents to ask the user about pending changes before running tests. The previous wording fired even when the user explicitly asked for a test run.

Before:
> Build and tests can take a long time. Before running tests, ask the user if they have more changes to make.

After:
> Build and tests can take a long time. If the user explicitly asked to run tests, run them. Otherwise (you are running tests on your own to verify a change), first ask the user if they have more changes to make.

### Why are the changes needed?

The intent of the original instruction was to avoid kicking off a long, agent-initiated test run when the user has more edits coming. But as written, it also applies when the user explicitly requests a test run, which makes the prompt redundant and annoying. Spelling out both branches makes it easier for LLMs to follow the rule correctly.

### Does this PR introduce _any_ user-facing change?

No. Documentation-only update for coding agent instructions.

### How was this patch tested?

N/A — documentation only.

### Was this patch authored or co-authored using generative AI tooling?

Generated-by: Claude Code (Claude Opus 4.7)

Closes #55685 from cloud-fan/minor-agents-md-test-prompt.

Authored-by: Wenchen Fan <wenchen@databricks.com>
Signed-off-by: Wenchen Fan <wenchen@databricks.com>
(cherry picked from commit feab925)
Signed-off-by: Wenchen Fan <wenchen@databricks.com>
cloud-fan added a commit that referenced this pull request May 6, 2026
…ENTS.md

### What changes were proposed in this pull request?

Tighten the wording in `AGENTS.md` that tells coding agents to ask the user about pending changes before running tests. The previous wording fired even when the user explicitly asked for a test run.

Before:
> Build and tests can take a long time. Before running tests, ask the user if they have more changes to make.

After:
> Build and tests can take a long time. If the user explicitly asked to run tests, run them. Otherwise (you are running tests on your own to verify a change), first ask the user if they have more changes to make.

### Why are the changes needed?

The intent of the original instruction was to avoid kicking off a long, agent-initiated test run when the user has more edits coming. But as written, it also applies when the user explicitly requests a test run, which makes the prompt redundant and annoying. Spelling out both branches makes it easier for LLMs to follow the rule correctly.

### Does this PR introduce _any_ user-facing change?

No. Documentation-only update for coding agent instructions.

### How was this patch tested?

N/A — documentation only.

### Was this patch authored or co-authored using generative AI tooling?

Generated-by: Claude Code (Claude Opus 4.7)

Closes #55685 from cloud-fan/minor-agents-md-test-prompt.

Authored-by: Wenchen Fan <wenchen@databricks.com>
Signed-off-by: Wenchen Fan <wenchen@databricks.com>
(cherry picked from commit feab925)
Signed-off-by: Wenchen Fan <wenchen@databricks.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants