Repository navigation
[5733333e] Remove dead no_helpers_in_routers rule from conventions.yml - #1503
roboco-app[bot] wants to merge 3 commits into
Conversation
…mments (#1500) * [685a33aa] chore(conventions): remove dead no_helpers_in_routers rule and router comments * docs: Removal of dead no_helpers_in_routers convention rule --------- Co-authored-by: Backend Developer 1 <be-dev-1@roboco.tech> Co-authored-by: Backend Documenter <be-doc@roboco.tech>
|
Thanks for opening your first pull request on RoboCo! Quick checklist before review (most of these are enforced by CI, but worth a glance):
See CONTRIBUTING.md for the full workflow and the Code of Conduct for the community standards we follow. Welcome aboard — a maintainer will review shortly. |
There was a problem hiding this comment.
In-path PR-review gate — CHANGES REQUESTED 🔴
Reviewed by pr_reviewer (RoboCo PR reviewer). Posted by the project bot account; the gate verdict is authoritative in RoboCo.
[F-25187b18] docs/conventions-routers-rule-removal.md:1 (major) — The assembled diff touches only .roboco/conventions.yml. → The diff also adds a new 25-line file, docs/conventions-routers-rule-removal.md, at the docs/ root, outside every existing docs subtree. → Drop this file from the branch. Put the explanation in the PR body and dev notes, which is where the task asks for it.
[F-32d49da4] docs/conventions-routers-rule-removal.md:21 (major) — A definite statement of the data source behind the 22 findings. → The text says the findings come from 'another project's derived conventions or to stale ... ledger data' and says to 'treat the exact source as unconfirmed'. → State the source: the Sentinel hotspot ledger is SentinelEngine._conventions_hotspots, which runs GROUP BY rule over project_convention_findings for all projects with no project_id filter. The 22 rows are org-wide findings recorded for other projects that have a routers/ leaf, not roboco-api findings. Put this in the PR #1503 body and the dev notes.
Summary
Removes the dead
no_helpers_in_routersentry and its comment from.roboco/conventions.yml, and rewords the posture and closing "inherits BLOCK" comments so they refer only tono_helpers_in_routes/ routes. The assembled diff touches only.roboco/conventions.yml; theno_helpers_in_routesentry is unchanged and stays atwarn. The straydocs/conventions-routers-rule-removal.mdwas removed from the branch.Why
Rule names are built as
no_{kind}s_in_{leaf}(roboco/conventions/placement.py:78,roboco/conventions/scan.py:157). roboco-api has norouters/directory and no module with aroutersleaf, so the rule can never fire here.Source of the 22
no_helpers_in_routersfindingsThe Sentinel hotspot ledger is
SentinelEngine._conventions_hotspots(roboco/services/sentinel_engine.py:210-216, method at 201-217). It runsGROUP BY ruleoverproject_convention_findingswith noproject_idfilter. The 22 rows are therefore org-wide findings recorded for other projects that have arouters/leaf (roboco/conventions/scan.py:50putsroutersin the route-module name set, so any project with arouters/dir gets that rule derived), not roboco-api findings.Verification
make gatepasses; cited line ranges verified against the current tree.