chore: improve test guidelines in AGENTS.md#387
Merged
Conversation
Add explicit rules for testing public APIs only, requiring type annotations on tests/fixtures, and keeping imports at module level. Fix fixture reference to reflect the actual pytest_plugins layout. Made-with: Cursor
andreatgretel
approved these changes
Mar 9, 2026
Contributor
Greptile SummaryThis PR improves the test guidelines section of
|
| Filename | Overview |
|---|---|
| AGENTS.md | Documentation-only update: fixes the fixture reference from a non-existent tests/conftest.py to the correct pytest_plugins module paths, and adds three new, accurate test guidelines (public-API-only, type annotations, module-level imports) plus a ids= recommendation for parametrize. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[pytest test run] --> B{Package conftest.py}
B --> C[pytest_plugins declaration]
C --> D[data_designer.config.testing.fixtures]
C --> E[data_designer.engine.testing.fixtures]
D --> F[stub_data_designer_config_str\nand other config fixtures]
E --> G[engine-level shared fixtures]
B --> H[Local conftest.py\nin each test directory]
H --> I[Package/module-specific fixtures]
F & G & I --> J[Individual test functions]
Last reviewed commit: 36580d7
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
_-prefixed internals), require type annotations on tests/fixtures, keep imports at module levelpytest_pluginslayout (data_designer.config.testing.fixtures/data_designer.engine.testing.fixtures) instead of a nonexistenttests/conftest.pyids=with@pytest.mark.parametrizefor readable test namesTest plan
Made with Cursor