LCORE-304: Info about tests #251
Conversation
WalkthroughDocumentation was reorganized and updated: references to the Python tool "pdm" were replaced with "uv" in contributing instructions, the testing section was moved from CONTRIBUTING.md to a new docs/testing.md file, and the README.md table of contents and sections were restructured. A minimal docs/README.md was introduced for GitHub Pages. Changes
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (7)
docs/README.md (1)
1-2: Placeholder is too thin – add at least a short intro or redirect
docs/README.mdshows only the H-1 header. GitHub Pages will render a near-empty page, which looks broken.-# GitHub pages +# Lightspeed-Stack Documentation + +Welcome 👋 – this directory is published via GitHub Pages. +See the full documentation at [`../README.md`](../README.md) or browse sub-pages in `docs/`.docs/testing.md (3)
5-8: Fix list numbering / indentation (MD007)The three bullets render as a single paragraph because each line starts with
1.without a blank line after the heading. Either insert blank lines or use proper ordered-list syntax:-1. Unit Tests -1. Integration Tests -1. End to end Tests +1. **Unit tests** +2. **Integration tests** +3. **End-to-end tests**
160-169: Add language specifiers to fenced code blocks (MD040)Two blocks (stdout capture & log capture) miss a language tag, breaking syntax highlighting and some linters. Prefix them with
python:-``` +```python def test_foobar(capsys): ...
60-69: Mixed list markers trigger MD004 – unify to asterisks or dashesLines showing the directory tree switch from
*to-. Pick one style (project uses*elsewhere) for consistency.README.md (1)
14-35: Run the TOC generator – anchors/indentation are out of syncAfter moving “Integration with Llama Stack” and adding “Testing”, the manual list no longer matches automatic anchors (indent depth, alphabetical order).
Please execute:UpdateToc(ormake toc) so the generated TOC stays reliable.CONTRIBUTING.md (2)
6-23: TOC still lists the removed Testing subsectionRows 18-22 point to headings that no longer exist. Regenerate the TOC to avoid 404-style jumps.
37-43: Typo: “Prerequisities” → “Prerequisites”Small spelling fix improves searchability.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
CONTRIBUTING.md(2 hunks)README.md(3 hunks)docs/README.md(1 hunks)docs/testing.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/testing.md
18-18: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
19-19: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
20-20: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
21-21: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
23-23: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
24-24: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
26-26: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
27-27: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
28-28: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
30-30: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
31-31: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
32-32: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
37-37: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
38-38: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
39-39: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
40-40: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
41-41: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
42-42: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
43-43: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
60-60: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
60-60: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
61-61: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
61-61: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
68-68: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
69-69: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
160-160: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
175-175: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🔇 Additional comments (2)
docs/testing.md (1)
31-35: Paragraph refers to “integration” coverage inside “Unit tests” sectionThe wording is confusing:
“Currently code coverage threshold for integration tests is set to 60%”
This sentence lives inside the Unit tests chapter. Either move it to the Integration tests chapter or change “integration” → “unit”.
CONTRIBUTING.md (1)
63-70: Make target names don’t match actual MakefileDocs now say:
make unit-tests make integration-testsThe repository (and newly added
docs/testing.md) usesmake test-unit/make test-integration.-make unit-tests -make integration-tests +make test-unit +make test-integration
1 participant
Description
LCORE-304: Info about tests
Type of change
Related Tickets & Documents
Summary by CodeRabbit