Skip to content

Commit efd7cfd

Browse files
authored
Merge pull request #63 from badMade/badmade/fix-typo-in-codebase
[AI-Assisted] Add issue scan proposing typo, bug, docs, and test follow-up tasks
2 parents 27c415a + dbfdad3 commit efd7cfd

1 file changed

Lines changed: 25 additions & 0 deletions

File tree

docs/issue_task_proposals.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Codebase issue scan: proposed fix tasks
2+
3+
## 1) Naming consistency task
4+
- **Issue:** The HTTP user agent string uses `clawd-rust-tools/0.1`, while the codebase appears to use a mix of `claw*` and `clawd*` identifiers across repository/product naming, telemetry, env vars, and file prefixes.
5+
- **Impact:** Inconsistent telemetry/log tagging and harder grep/observability across services when searching for either `claw` or `clawd` identifiers.
6+
- **Task proposal:** Decide on the intended prefix convention for these identifiers (`claw*` vs `clawd*`), update the user-agent token to match that convention (ideally via a centrally-defined crate/version-derived user-agent constant), and update any tests that assert the old literal.
7+
- **Acceptance criteria:** The chosen naming convention is applied consistently to the user-agent token and any related references/tests updated by this task; no behavior changes beyond identifier consistency.
8+
9+
## 2) Bug fix task
10+
- **Issue:** `src.main` ignores filtering flags (e.g., `--no-plugin-commands`, `--no-skill-commands` for `commands`; `--simple-mode`, `--no-mcp`, `--deny-tool` for `tools`) when `--query ...` is used. This happens because the query paths call `render_command_index(...)` or `render_tool_index(...)` directly without applying the include/exclude filters.
11+
- **Impact:** CLI behavior is inconsistent and user-provided filtering flags are silently ignored for query usage.
12+
- **Task proposal:** Refactor command and tool index rendering so query and non-query paths share the same filtered source (e.g., call `get_commands(...)`/`get_tools(...)` first, then apply query search over that filtered set).
13+
- **Acceptance criteria:** `commands --query X --no-plugin-commands` and `tools --query Y --no-mcp` produce outputs that respect each exclusion flag.
14+
15+
## 3) Code comment/documentation discrepancy task
16+
- **Issue:** The lane completion module-level docs say completion is detected when "Code pushed (has output file)", but `detect_lane_completion(...)` does not inspect `output_file`; it only trusts the external boolean `has_pushed`.
17+
- **Impact:** The inline documentation overstates what this function validates itself, which can mislead future maintainers and reviewers.
18+
- **Task proposal:** Align docs/comments with implementation **or** update implementation to validate `output.output_file` semantics directly (and document exact source-of-truth for "pushed").
19+
- **Acceptance criteria:** Comments/docs and runtime behavior agree on how push status is determined.
20+
21+
## 4) Test improvement task
22+
- **Issue:** Snapshot-size tests in `tests/test_porting_workspace.py` use hard minimums (`>=150` commands, `>=100` tools, coverage thresholds), which are brittle for legitimate snapshot churn and can produce noisy failures.
23+
- **Impact:** Reduced test signal quality; harmless snapshot updates can fail CI even when behavior remains correct.
24+
- **Task proposal:** Replace absolute magic-number thresholds with invariant-based assertions (e.g., non-empty snapshots, monotonic schema checks, command/tool lookup sanity) plus a single snapshot-contract check tied to explicit version metadata.
25+
- **Acceptance criteria:** Tests fail only on semantic regressions, not ordinary curated snapshot updates.

0 commit comments

Comments
 (0)