docs: add 'Run one focused test' section to CONTRIBUTING.md#1177
docs: add 'Run one focused test' section to CONTRIBUTING.md#1177muddlebee merged 2 commits intoTracer-Cloud:mainfrom
Conversation
Greptile SummaryThis PR adds a "Run one focused test" subsection to the Development Workflow in
Confidence Score: 3/5Not safe to merge as-is — the documentation section will render as broken plain text due to literal The P1 formatting bug means the added section is non-functional documentation: the heading won't render as a heading and the code fences won't render as code blocks in any standard Markdown viewer. The content inaccuracy (directory-wide commands vs. single-test focus) is a secondary P2 concern. Both should be corrected before merging. CONTRIBUTING.md — all added lines need the leading Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Developer makes a change] --> B[Run focused test\npytest tests/cli/test_foo.py]
B --> C{Tests pass?}
C -- Yes --> D[Run full local checks\nmake lint + format-check\n+ typecheck + test-cov]
C -- No --> E[Fix code / tests]
E --> B
D --> F{All four pass?}
F -- Yes --> G[Open Pull Request]
F -- No --> H[Fix issues]
H --> D
Reviews (1): Last reviewed commit: "docs: add 'Run one focused test' section..." | Re-trigger Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
| +### Run one focused test | ||
| + | ||
| +Run a single CLI test file: | ||
| +``` | ||
| +pytest tests/cli/ | ||
| +``` | ||
| + | ||
| +Run one specific test in the tools suite: | ||
| +``` | ||
| +pytest tests/tools/ | ||
| +``` | ||
| + | ||
| +Run a synthetic scenario (no live infra needed): | ||
| +``` | ||
| +pytest tests/synthetic/ | ||
| +``` | ||
| + |
There was a problem hiding this comment.
+ characters in file content
Every line in the new section starts with a literal + character (e.g. +### Run one focused test, +pytest tests/cli/). These appear to have been copied directly from a diff/patch view. As a result, the heading will not render as Markdown and the fenced code blocks will not display correctly.
| +### Run one focused test | ||
| + | ||
| +Run a single CLI test file: | ||
| +``` | ||
| +pytest tests/cli/ | ||
| +``` | ||
| + | ||
| +Run one specific test in the tools suite: | ||
| +``` | ||
| +pytest tests/tools/ | ||
| +``` | ||
| + | ||
| +Run a synthetic scenario (no live infra needed): | ||
| +``` | ||
| +pytest tests/synthetic/ | ||
| +``` |
There was a problem hiding this comment.
The section is titled "Run one focused test" and the descriptions say "a single CLI test file" / "one specific test", but each command targets a whole directory and will run hundreds of tests. For actually isolating one test, a developer would need pytest tests/cli/test_main.py (single file), pytest tests/tools/test_foo.py::TestClass::test_method (single function), or pytest tests/cli/ -k "test_investigate" (keyword filter). Consider updating the commands or renaming the section to "Run a subset of tests."
| All four must pass. **CI will block merging if any fail.** | ||
| +### Run one focused test |
There was a problem hiding this comment.
There is no blank line between "All four must pass…" and the new ### Run one focused test heading. Some Markdown renderers require a blank line before a heading to parse it correctly.
akshat1074
force-pushed
the
docs/run-focused-test-section
branch
from
723aa81 to
084ee5e
Compare
|
🔥 Another one. @akshat1074 said "here's a PR" and maintainers said "ship it". That's how it's done.
👋 Join us on Discord - OpenSRE : hang out, contribute, or hunt for features and issues. Everyone's welcome. |
2 participants
Fixes #1128
Describe the changes you have made in this PR -
docs: add 'Run one focused test' section to CONTRIBUTING.md
Added a short Run one focused test section under Development Workflow with three copy-paste-ready pytest commands using real repo paths (tests/cli/, tests/tools/, tests/synthetic/)
Note: Please check Allow edits from maintainers if you would like us to assist in the PR.