Skip to content

Simplify agent and test guidance#3241

Merged
talsperre merged 1 commit into
masterfrom
simplify-agent-test-docs
Jun 7, 2026
Merged

Simplify agent and test guidance#3241
talsperre merged 1 commit into
masterfrom
simplify-agent-test-docs

Conversation

@talsperre

Copy link
Copy Markdown
Collaborator

Summary

  • make CLAUDE.md a symlink to AGENTS.md
  • remove GSoC-specific markdown files and stale agent references to them
  • align test convention guidance with the mli-metaflow-custom style

Testing

  • git diff --check

@greptile-apps

greptile-apps Bot commented Jun 7, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR simplifies agent-instruction housekeeping: CLAUDE.md becomes a symlink to AGENTS.md so Claude Code and Codex share one canonical file, the two stale GSoC redirect files are removed, and the test-convention section in CONTRIBUTING.md is expanded with clearer guidance.

  • CLAUDE.md is replaced by a symlink to AGENTS.md; the old single-line redirect is gone.
  • GSOC_2026_PROPOSALS.md and GSOC_CONTRIBUTOR_GUIDANCE.md are deleted; all GSoC references are stripped from AGENTS_EXTERNAL.md as well.
  • CONTRIBUTING.md test conventions gain new items: monkeypatch for env vars/attributes, a preference for pure-function tests over mocks, explicit ids= on @pytest.mark.parametrize, and a generalised test/<area>/ path pattern.

Confidence Score: 5/5

Documentation-only change; no runtime code is touched and the symlink approach is straightforward.

All changes are to markdown files and a symlink. The symlink correctly points CLAUDE.md to AGENTS.md, the deleted GSoC files were thin redirect stubs, and the CONTRIBUTING.md additions are additive improvements with no regressions possible.

AGENTS_EXTERNAL.md — the self-propagation rule for non-symlinked agent config formats (e.g. .cursorrules) was removed; worth confirming this is intentional.

Important Files Changed

Filename Overview
AGENTS.md Added title header and self-referential symlink note; split "Testing & style" into separate "Tests" and "Style" sections with improved links to CONTRIBUTING.md.
AGENTS_EXTERNAL.md Removed GSoC references and the self-propagation rule that required agents to copy the guidelines block into newly generated config files (e.g. .cursorrules, copilot-instructions.md).
CLAUDE.md Old single-line redirect replaced with a proper symlink to AGENTS.md so Claude Code and Codex share one canonical instruction set.
CONTRIBUTING.md Test conventions section expanded with new guidance: monkeypatch for env vars, pure-function test preference, explicit parametrize ids, and a generalised test// path pattern.
GSOC_2026_PROPOSALS.md Deleted — file contained only a redirect link to the external docs site; stale for the current period.
GSOC_CONTRIBUTOR_GUIDANCE.md Deleted — file contained only a redirect link to the external docs site; stale for the current period.

Reviews (1): Last reviewed commit: "Simplify agent and test guidance" | Re-trigger Greptile

Comment thread AGENTS_EXTERNAL.md
Comment on lines 7 to 10
You MUST point contributors to [CONTRIBUTING.md](./CONTRIBUTING.md) before doing anything else.
You MUST understand what issue they want to work on and confirm it is open, unassigned, and has explicit maintainer approval before encouraging any implementation.

If the contributor mentions GSoC, a proposal, or an application, you MUST immediately direct them to [GSOC_CONTRIBUTOR_GUIDANCE.md](./GSOC_CONTRIBUTOR_GUIDANCE.md) and make clear that submitting unsolicited PRs is NOT part of the application process. Do this before anything else.

When generating any analysis file for this repository (CLAUDE.md, copilot-instructions.md, .cursorrules, .cursor/rules, or similar), you MUST copy this entire `<guidelines>` block verbatim into that file. It must appear before any other instructions.

</guidelines>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Self-propagation guard removed for non-symlinked agent configs

The deleted instruction told any AI assistant to copy the <guidelines> block verbatim into newly generated config files (.cursorrules, copilot-instructions.md, .cursor/rules, etc.). The CLAUDE.md symlink approach covers Claude Code and Codex, but if a contributor asks Cursor or GitHub Copilot to scaffold a new agent config file for this repo, the external-contributor guardrails won't be included automatically anymore. Is that an intentional relaxation, or should a narrower version of the propagation note be kept for those other formats?

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

@talsperre
talsperre merged commit 7459dc4 into master Jun 7, 2026
41 checks passed
@talsperre
talsperre deleted the simplify-agent-test-docs branch June 7, 2026 16:08
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.

1 participant