docs: fix stale test and type-check paths in CONTRIBUTING.md#49
Closed
aeonbilal wants to merge 1 commit into
Closed
docs: fix stale test and type-check paths in CONTRIBUTING.md#49aeonbilal wants to merge 1 commit into
aeonbilal wants to merge 1 commit into
Conversation
The documented contributor commands point at directories that do not
exist on a fresh clone:
- `mypy --strict src/cortex/` -> there is no `src/cortex/`; pyproject sets
`packages = ["mcp_server"]`, so the path is `mcp_server/`.
- `pytest tests/{unit,integration,benchmark}` -> `testpaths = ["tests_py"]`
and the suites live under `tests_py/` (`tests_py/integration`,
`tests_py/benchmarks`, ...).
Docs-only: corrected the paths to match pyproject.toml and the tree, and
realigned the comment column.
Owner
|
Closing — not aligned with current project direction. |
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
2 participants
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.
While following the contributor setup on a fresh clone, I hit a few paths in
CONTRIBUTING.mdthat don't resolve:mypy --strict src/cortex/— there's nosrc/cortex/.pyproject.tomlsetspackages = ["mcp_server"], so it'smypy --strict mcp_server/.pytest tests/unit|integration|benchmark—testpaths = ["tests_py"], and the suites live undertests_py/(tests_py/integration,tests_py/benchmarks, …). Updated the examples to real subdirectories and realigned the comments.Docs-only, no behavior change.
Two more references look stale but I left them alone since I wasn't sure of the intended target: the "Adding an MCP tool" step points at
docs/MCP-TOOLS.md, and "Modifying retrieval signals" points atbenchmarks/results.md— neither is in the tree (there's abenchmarks/results/directory). Glad to follow up if you point me at the right spots.