docs: describe testing - #846
Conversation
|
Documentation preview for this pull request is available at: |
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
Several documented commands and CI behaviors do not match the checked-in configuration.
Get a fresh assessment by requesting another Copilot review.
Review effort: Balanced
Findings: 6
Open (6)
What changed in this PR
Adds developer documentation for the repository’s testing layers and CI orchestration.
Changes:
- Documents test types, commands, and selection guidance.
- Links the guide from the internals index.
| File | Description |
|---|---|
| docs/internals/testing.rst | Adds the testing guide. |
| docs/internals/index.rst | Adds the guide to the internals navigation. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
MaximilianSoerenPollak
left a comment
MaximilianSoerenPollak
left a comment
There was a problem hiding this comment.
Seems good in my eyes.
| uvx pre-commit run --all-files | ||
|
|
||
| The hooks cover: | ||
|
|
||
| - Generic file hygiene: | ||
| YAML/TOML/JSON validity, trailing whitespace, end-of-file newlines, | ||
| merge-conflict markers, case conflicts, and private keys. | ||
| - Python style and linting with Ruff (fix in place). | ||
| - Python type checking with BasedPyright. | ||
| - GitHub Actions workflow linting with actionlint. | ||
| - Bazel module hygiene, including ``bazel mod tidy`` and a lockfile consistency check. | ||
| - Eclipse copyright header presence. |
There was a problem hiding this comment.
Probably good to describe this, idk if this should be in testing but I also do not know a better place of the top of my head.
📌 Description
We had no overview about the testing in docs-as-code so far and this contains more details than the process description.
🚨 Impact Analysis
✅ Checklist