Skip to content

docs: define testing approach for agents#7

Merged
sergdort merged 1 commit into
mainfrom
docs/testing-approach-discussion
Mar 1, 2026
Merged

docs: define testing approach for agents#7
sergdort merged 1 commit into
mainfrom
docs/testing-approach-discussion

Conversation

@LogenNineFingersIsAlive

Copy link
Copy Markdown
Collaborator

Summary\n- add a dedicated Testing Approach (Required for Agents) section to AGENTS.md\n- codify principles for readable, requirement-led tests\n- add explicit guardrails against gaming tests and shipping flaky-test hacks\n- require hermetic integration tests (isolated DB/env + cleanup)\n- clarify placeholder-test policy on feature branches and before merge\n\n## Notes\n- docs-only change\n

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Adds explicit, agent-facing testing guidelines to ensure changes are validated with readable, requirement-led tests and to discourage flaky-test or “green-at-all-costs” practices.

Changes:

  • Introduces a new Testing Approach (Required for Agents) section in AGENTS.md.
  • Defines principles for readable tests, requirement-driven coverage, and red→green→refactor workflow.
  • Sets guardrails for flaky tests and requires hermetic integration tests (isolated DB/env + cleanup).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread AGENTS.md
- Feature tests should validate behavior users/business care about.
- Keep lower-level/unit tests for mechanics, but feature coverage must stay requirement-led.

3. **Do not “game” tests.**

Copilot AI Mar 1, 2026

Copy link

Choose a reason for hiding this comment

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

This line introduces a curly quote character (“ ”). The rest of AGENTS.md appears to use plain ASCII punctuation, so keeping straight quotes avoids encoding/grep/copy-paste issues in terminals and tooling.

Suggested change
3. **Do not game tests.**
3. **Do not "game" tests.**

Copilot uses AI. Check for mistakes.
Comment thread AGENTS.md
- When tests fail, first verify whether requirements are correct and still desired.
- Never patch tests with hacks that hide real regressions.

4. **Default to red → green → refactor.**

Copilot AI Mar 1, 2026

Copy link

Choose a reason for hiding this comment

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

This heading uses a Unicode arrow (→). Consider using ASCII (e.g., "->" or words like "then") to keep the document consistent and avoid display issues in some environments.

Suggested change
4. **Default to red green refactor.**
4. **Default to red -> green -> refactor.**

Copilot uses AI. Check for mistakes.
@sergdort
sergdort merged commit fe6d6b3 into main Mar 1, 2026
5 checks passed
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