Linus-Dashboard
AGENTS.md214 starsChanged 31 days agoMITView on GitHub
Linus Dashboard is a Home Assistant integration (custom_components/linus_dashboard/, Python) with a TypeScript frontend (src/). Read this file before you change anything. CONTRIBUTING.md covers the development environment. npm run build writes generated files to custom_components/linus_dashboard/www/: linus-strategy.js, its .map, and about a hundred content-hashed chunks. They are ignored by git. - Never push generated files from www/: do not force-add them, and do not edit them by hand. - CI builds every pull request and publishes the result as the build-output artifact,…
- Reads credentials
Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.
Of the AGENTS.md files we read, the 31,439 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository10 other files it gives its agents.
- .aidriven/AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- .github/copilot-instructions.mdCopilot instructions
- debugSkill
- implementSkill
- release-betaSkill
- release-checkSkill
- release-rollbackSkill
- release-stableSkill
- reviewSkill
The file
We split this AGENTS.md into the rules it gives an agent
7 rules. About 0 are common, 2 are distinctive, and 5 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈2
Distinctive · estimate
This author's own choices. Worth a look.
5
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- could be automatic: a setting could enforce it
- Very specific: line 12
Never push generated files from www/: do not force-add them, and do not edit them by hand.
- Distinctive: line 25
Run what your change touches, and paste the results in the PR.
- Very specific: line 49
Text and translations: Never hardcode a user-facing string, in any language.
- Very specific: line 57
Versions: Do not bump package.json or manifest.json.
- Very specific: line 58
Secrets: Never commit .env, a token, or a Home Assistant instance URL.
- Distinctive: line 63
Write the title, description, code comments and commit messages in English.
- Very specific: line 64
Start commit subjects with a type (feat:, fix:, docs:, refactor:, test:, chore:): the release notes are sorted by it.
≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Instructions for AI coding agents (and their humans)
Linus Dashboard is a Home Assistant integration (custom_components/linus_dashboard/, Python) with a
TypeScript frontend (src/). Read this file before you change anything. CONTRIBUTING.md
covers the development environment.
The frontend build is never committed
npm run build writes generated files to custom_components/linus_dashboard/www/: linus-strategy.js,
its .map, and about a hundred content-hashed chunks. They are ignored by git.
- Never push generated files from
www/: do not force-add them, and do not edit them by hand. - CI builds every pull request and publishes the result as the
build-outputartifact, and every release builds its own zip. Maintainers test your PR from that artifact. - Build locally to test your change: without a build, Home Assistant has no dashboard to serve.
- A branch that changed
linus-strategy.jsconflicts withmain. Resolve it by removing the file:git rm --cached custom_components/linus_dashboard/www/linus-strategy.js*. Remove any committed chunk the same way: it merges without a conflict and would stay tracked. - The other files in
www/(browser_mod.js,custom-elements-guard.js,lovelace-mushroom/,lovelace-card-mod/,stack-in-card/,swipe-card/) are committed third-party or static files. Leave them out of feature work.
Checks to run before you push
Run what your change touches, and paste the results in the PR.
| Change | Command |
| Frontend install | npm ci |
| Frontend tests | npx vitest run |
| Types | npm run type-check |
| ESLint | npm run lint:check |
| Build | npm run build |
| Python lint | python3 -m ruff check . and python3 -m ruff format . --check |
| Python tests | python3 -m pytest tests/python --ignore=tests/python/integration |
| Integration tests (real HA) | python3 -m pytest tests/python/integration, in a separate environment with pytest-homeassistant-custom-component (see .github/workflows/ci.yml) |
Python dependencies are in requirements.txt and requirements_test.txt. CI reports ESLint and type
errors without failing the job, so read them yourself. CI does not run the frontend tests at all:
npx vitest run is on you. A bug fix comes with a test that fails without it.
Unit tests do not show that the dashboard works. For a visible change, run it in Home Assistant:
npm run build, then make dev (make dev only builds when no build exists, so it can serve an old
one), then reload the browser with the cache cleared. Say in the PR what you checked. If you could not
run it, say so.
Rules that come up in review
- Text and translations. Never hardcode a user-facing string, in any language. Add every new key to
both
custom_components/linus_dashboard/translations/en.jsonandfr.json. - Documentation. User documentation exists in English and French: update
README.mdandREADME-fr.mdtogether, and both versions of a page indocs/. - Compatibility. The minimum Home Assistant version is in
hacs.json. Do not use an API that is newer than it without a guard. - Line endings. Some files use CRLF (
README.md,CONTRIBUTING.md). Keep them: the diff must show only the lines you changed, never a whole-file rewrite. - Versions. Do not bump
package.jsonormanifest.json. The release workflows do it. - Secrets. Never commit
.env, a token, or a Home Assistant instance URL.
Pull requests
- One topic per PR, branched from an up-to-date
main. Unrelated fixes go in their own PR. - Write the title, description, code comments and commit messages in English.
- Start commit subjects with a type (
feat:,fix:,docs:,refactor:,test:,chore:): the release notes are sorted by it. - Fill in the pull request template. Say what changed for the user and how you tested it.
- A pull request from a fork may wait for a maintainer to approve its CI run. A push after a review does not request a new one: say in the PR when it is ready again.
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.