Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,20 @@ always means the deployed record rescored against the new methodology, which
is an operation, not a side effect — say so here so the pin bump that carries
it is deliberate.

## [0.13.0] — 2026-08-28

### Changed
- `guide/` and `guides/` top-level directories now count as documentation
directories (`has_docs_dir`), alongside `doc/`, `docs/`, `documentation/`
and `wiki/`. `guide/` is the established mdBook convention in the Rust
ecosystem; wasm-bindgen's maintainer reported scoring 0 on the criterion
despite a full guide in the repository (issue #11).

**Downstream impact:** pin bump only — no new report field, no detail codes,
no `METRICS_VERSION` change. The formula is unchanged; the collected signal
widens, so affected repositories pick up the points at their next rescan.
No rescore of the record: stored reports keep their collected signals.

## [0.12.0] — 2026-08-27

### Changed
Expand Down
2 changes: 1 addition & 1 deletion docs/report-schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -427,7 +427,7 @@ safe direction to fail for a figure that is descriptive only.
| ----- | --------- |
| `has_ci`, `ci_workflows` | `.github/workflows/*.yml\|yaml` |
| `has_tests` | `test(s)`/`spec(s)`/`__tests__` directories or test-file naming patterns |
| `has_docs_dir` | Non-empty `doc/`, `docs/`, `documentation/`, or `wiki/` directory |
| `has_docs_dir` | Non-empty `doc/`, `docs/`, `documentation/`, `wiki/`, `guide/`, or `guides/` directory |
| `has_linter_config`, `linter_configs` | Known linter config files (ruff, flake8, eslint, golangci, …) |
| `has_editorconfig`, `has_precommit_config` | `.editorconfig`, `.pre-commit-config.yaml` |

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "inspect-scanner"
version = "0.12.0"
version = "0.13.0"
description = "CLI scanner that audits public GitHub repositories and produces JSON reports"
readme = "README.md"
requires-python = ">=3.11"
Expand Down
2 changes: 1 addition & 1 deletion src/scanner/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
from .models import Report

__all__ = ["Report"]
__version__ = "0.12.0"
__version__ = "0.13.0"
2 changes: 1 addition & 1 deletion src/scanner/collect.py
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ class TreeEntry(NamedTuple):
}

TEST_DIR_NAMES = {"test", "tests", "spec", "specs", "__tests__", "testing"}
DOC_DIR_NAMES = {"doc", "docs", "documentation", "wiki"}
DOC_DIR_NAMES = {"doc", "docs", "documentation", "wiki", "guide", "guides"}
TEST_FILE_PATTERNS = ("test_*.py", "*_test.py", "*_test.go", "*.test.js", "*.test.ts", "*.spec.js", "*.spec.ts", "*Test.java", "*Test.php")

# --- AI readiness signal detection ----------------------------------------
Expand Down
3 changes: 2 additions & 1 deletion tests/test_signals.py
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,8 @@ def test_no_embedded_config_leaves_signals_unchanged():


def test_docs_dir_aliases():
for directory in ("doc", "docs", "documentation", "wiki"):
# guide/guides: mdBook convention (wasm-bindgen PR #5291 feedback, issue #11).
for directory in ("doc", "docs", "documentation", "wiki", "guide", "guides"):
assert _quality([f"{directory}/index.md"]).has_docs_dir, directory
# A file named like a docs dir, or a bare top-level file, is not a docs dir.
assert not _quality(["documentation.md"]).has_docs_dir
Expand Down
Loading