lint
Skill81 starsChanged 3 days agoMITView on GitHub
Run every CI gate locally — ruff lint and format, pyright, import boundaries, mdformat, prettier, version consistency, unit tests, scenario tests, frontend card checks, docs build — and fix whatever fails. Use before committing, before opening a pull request, when asked to lint, format, type check, verify, or make CI pass, and when diagnosing a red CI run.
82 other projects use a version of this.
Adopted by
Most recently taken up by
- microsoft/coreai-design-systemtheir own version, first seen Nov 15, 2026
- jakubtobiasz/second-brain-templatetheir own version, first seen Nov 15, 2026
- wikilayer/skillstheir own version, first seen Nov 13, 2026
- playingpossumm/loose-endstheir own version, first seen Nov 10, 2026
- HurricaHjz/second-yourselftheir own version, first seen Nov 9, 2026
- PMDevSolutions/Flaviantheir own version, first seen Nov 8, 2026
Used with
Projects with it also use query, ingest and 9 more.
Other files people use alongside this one.
Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
ArtemXTechSkillquery
Query data from this vault. USE WHEN user asks about projects, clients, tasks, daily notes. Use grep to extract frontmatter - do NOT read full files.
Also in 18 projects that use this
JaimeGBASkillingest
Digest an external source (article, paper, transcript, URL, book chapter) and integrate its content into the knowledge base
Also in 27 projects that use this
BugRogerSkillproject
Project lifecycle management. Dispatches to Ada.
Also in 5 projects that use this
seongjaeryuSkillsave
Complete and save your current thinking to Bindly
Also in 5 projects that use this
GitHubSkillstate-management
CoreAI Sandbox's TanStack Query + mock-JSON data layer. USE WHEN: editing data-fetching hooks (`app/hooks/use*.ts`), adding mock data in `app/data/`, or wiring a component to query state.
Also in 3 projects that use this
AWSSkillissue
Implement a GitHub issue end-to-end — branch, code, test, docs, and commit.
Also in 4 projects that use this
Other versions82 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 82
- ray-project/ray★ 44ksame name
- FalkorDB/FalkorDB★ 11ksame name
- FastLED/FastLED★ 7.5ksame name
- fleetdm/fleet★ 7.2ksame name
- aaddrick/claude-desktop-debian★ 5.5ksame name
- cloudposse/atmos★ 1.4ksame name
- ethereum/execution-specs★ 1.2ksame name
- adobe/S3Mock★ 1.2ksame name
- maxGraph/maxGraph★ 1.2ksame name
- jason-effi-lab/karpathy-llm-wiki-vault★ 718same name
72 more not listed
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository18 other files it gives its agents.
- AGENTS.mdAGENTS.md
- agent-setupSkill
- config-flowSkill
- coverageSkill
- documentationSkill
- elementsSkill
- explain-planSkill
- integrationSkill
- manifestSkill
- modelSkill
- performanceSkill
- pythonSkill
- release-notesSkill
- scenariosSkill
- testingSkill
- translationsSkill
- update-docsSkill
- update-versionSkill
The file
We split this skill into the rules it gives an agent
5 rules. 0 are common, 1 is distinctive, and 4 are very specific to this project.
0
Common
Most of the 68 edited versions we read keep these.
1
Distinctive
This author's own choices. Worth a look.
4
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 10
Do not run the underlying tools individually.
- Very specific: line 27
Run it when touching a page with ``
guide `` blocks, which today are under docs/walkthroughs/. - Very specific: line 55
Run uv sync after changing either.
- Very specific: line 91
Add a Gate to GATES with its check command, and its autofix command if it has one.
- Very specific: line 92
Add a job to .github/workflows/ci.yml that runs python3 tools/check.py <name>, and add that job to the ci-passed needs list.
“Common” is measured: kept by at least 6 in 10 of the 68 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Lint, format, and type check
tools/check.py defines every gate once.
.github/workflows/ci.yml invokes it rather than repeating the commands, so a gate cannot pass locally and fail in CI because the two drifted apart.
Do not run the underlying tools individually; run the gate.
Step 1: run the gates
uv run check # every gate that runs locally, ~70s
uv run check --fast # ruff, pyright and unit tests, ~35s
uv run check --list # gate names and what each coversOne line per gate with timing, output only for failures, non-zero exit if anything failed.
Some gates cannot run outside GitHub Actions and are reported as skipped with the reason rather than silently omitted:
hassfestandhacsare provided wholly by third-party actions. Hassfest can still be run by hand, as Running hassfest describes; run it whenever you changetranslations/en.json,manifest.json,services.yaml, or repair issues.guideis opt-in rather than skipped: it is slow and needs Playwright Firefox, so it runs inguides.ymland is not part of the required check. Run it when touching a page with```guideblocks, which today are underdocs/walkthroughs/.uv run pytest -m guide -n 8 --timeout=300runs the guides in parallel;uv run check guideruns them one after another.
Step 2: fix what failed
Apply the mechanical fixes first:
uv run check --fixThis runs the autofix form of every formatter gate, then re-checks. Everything still failing needs a real change:
- Ruff lint: restructure the code so the rule is satisfied naturally.
# noqais a last resort and must carry a parenthesized reason. See thepythonskill. - Pyright: strict mode.
typing.castis a banned API — fix the types or use aTypeGuard. A# type: ignoreneeds a written explanation of why nothing else worked. - Import boundaries:
custom_components/haeo/core/**may import onlyhighspy,numpy, andtyping_extensions. A broken contract means the import belongs on the Home Assistant side of the boundary. - Tests:
filterwarnings = ["error"], so a new warning is a hard failure, andtimeout = 5turns a hang into a timeout. - Scenario tests: a diff means optimizer behavior changed.
Confirm that is intended before regenerating with
--snapshot-update. See thescenariosskill. - Docs build:
uv run zensical buildmust succeed. It runs in strict mode, so a broken internal link or#anchorfails it with the file and line; see thedocumentationskill. - Version consistency:
pyproject.tomlandcustom_components/haeo/manifest.jsonversions must match, andhomeassistant>=Xinpyproject.tomlmust equalhomeassistantinhacs.json. Runuv syncafter changing either.
The main branch is always clean, so any failure belongs to the current branch and must be fixed rather than worked around.
Running hassfest
Hassfest validates the manifest, translations, and services against Home Assistant's schemas.
For example, it rejects a fixable repair issue that has both a description and a fix_flow.
Its script is not in the homeassistant package, so fetch it from Home Assistant's source at the version the venv has:
version=$(uv run python -c "import homeassistant.const as c; print(c.__version__)")
git clone --quiet --depth 1 --filter=blob:none --sparse --branch "$version" \
https://github.com/home-assistant/core /tmp/hacore
git -C /tmp/hacore sparse-checkout set script
cd /tmp/hacore && PATH="$OLDPWD/.venv/bin:$PATH" \
python -m script.hassfest --integration-path "$OLDPWD/custom_components/haeo"Invalid integrations: 0 means it passed; errors are listed under the integration.
Hassfest calls ruff, so the venv must be on PATH.
CI runs the latest Home Assistant's hassfest, so a rule added since the pinned version can still fail there.
Running a single gate
uv run check pyright
uv run check test -- -k battery # arguments after -- go to the gate commandPass-through arguments require exactly one gate.
Changing what CI checks
Gates live in GATES in tools/check.py. To add one:
- Add a
GatetoGATESwith its check command, and its autofix command if it has one. - Add a job to
.github/workflows/ci.ymlthat runspython3 tools/check.py <name>, and add that job to theci-passedneeds list.
tests/test_check_gates.py fails if a gate exists without a CI job, if CI invokes a gate the runner does not define, or if a gate job is missing from the required check.
That test is why the two stay in step, so do not weaken it to make a change pass.
CI invokes the script as python3 tools/check.py rather than uv run check, because the Prettier and frontend jobs set up only Node.
The module is standard library only, so it runs without the project environment; the gate commands themselves still call uv run ... where needed.
On pull requests, reviewdog additionally annotates the diff for ruff, pyright, prettier and mdformat.
Those steps are advisory — continue-on-error — because the shared gate decides pass or fail.
Coverage is not a gate; codecov enforces it on changed lines. Use /coverage for that workflow.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

