agentleFS
Sign inStart free
ColorlibHQColorlibHQ/AdminLTE/AGENTS.md

AdminLTE

AGENTS.md46k starsChanged 6 years agoMITView on GitHub

AdminLTE 4 is a Bootstrap 5 dashboard template with vanilla TypeScript components. Use Node.js 22.22.3+, 24.16.0+, or 26.3.0+ and npm 10+. Install with npm ci. Use two-space indentation, UTF-8, LF endings, and final newlines as defined in .editorconfig. Follow neighboring code and repository ESLint/Stylelint rules. Prettier is configured with single quotes, semicolons, and a 100-character line width; Astro has its own configuration. Use strict TypeScript, PascalCase component classes, camelCase methods, and kebab-case component filenames such as card-widget.ts. Prefix Sass partials…

We split this AGENTS.md into the rules it gives an agent

5 rules. About 0 are common, 0 are distinctive, and 5 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    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
  1. Very specific:

    Use Node.js 22.22.3+, 24.16.0+, or 26.3.0+ and npm 10+.

    line 17
  2. Very specific:

    Use two-space indentation, UTF-8, LF endings, and final newlines as defined in .editorconfig.

    line 28
  3. Very specific:

    Use strict TypeScript, PascalCase component classes, camelCase methods, and kebab-case component filenames such as card-widget.ts.

    line 30
  4. Very specific:

    Add behavior and regression tests as tests/unit/<component>.test.ts.

    line 34
  5. Very specific:

    Follow the prevalent type(scope): summary commit format, for example fix(header): prevent horizontal overflow.

    line 40

≈ “Common” is an estimate: at least 1 in 5 of the 36,368 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.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

Repository Guidelines

Project Structure & Module Organization

AdminLTE 4 is a Bootstrap 5 dashboard template with vanilla TypeScript components.

  • src/ts/: component behavior; adminlte.ts is the library entry point, and util/ holds shared helpers.
  • src/scss/: Sass styles, component partials, mixins, and optional color themes.
  • src/html/: Astro demo/documentation pages and reusable Astro/MDX components.
  • src/assets/: source images and other static assets.
  • src/config/: Rollup, Astro, PostCSS, and asset-build configuration.
  • tests/unit/: unit tests and shared setup; tests/a11y.mjs checks built pages.
  • dist/ and src/html/public/: generated output. Edit source files; exclude compiled dist/ changes from contributor PRs.

Build, Test, and Development Commands

Use Node.js 22.22.3+, 24.16.0+, or 26.3.0+ and npm 10+. Install with npm ci.

  • npm start: run asset watchers and the Astro dev server at http://localhost:3000.
  • npm run build: clean and rebuild CSS, JavaScript, declarations, assets, and demo/documentation HTML.
  • npm run css / npm run js: rebuild styles or JavaScript independently.
  • npm run lint: check ESLint, Stylelint, Astro, and lockfile rules.
  • npm test: run Vitest once; npm run test-watch enables watch mode.
  • npm run production: clean, lint, test, compile, and check local gzip budgets.

Coding Style & Naming Conventions

Use two-space indentation, UTF-8, LF endings, and final newlines as defined in .editorconfig. Follow neighboring code and repository ESLint/Stylelint rules. Prettier is configured with single quotes, semicolons, and a 100-character line width; Astro has its own configuration.

Use strict TypeScript, PascalCase component classes, camelCase methods, and kebab-case component filenames such as card-widget.ts. Prefix Sass partials with _, and follow existing Bootstrap-compatible selectors and data-lte-* attributes.

Testing Guidelines

Add behavior and regression tests as tests/unit/<component>.test.ts. Vitest uses happy-dom and tests/unit/setup.ts; no numeric coverage threshold is configured. Cover DOM state, events, and cleanup where relevant.

For UI changes, build first, then run npm run test-a11y and npm run test-browser. Install Chromium with npx playwright install chromium; set BROWSERS=chromium,firefox,webkit for all engines. Serious and critical axe violations fail the check. Review responsive layouts, dark mode, and RTL manually.

Commit & Pull Request Guidelines

Follow the prevalent type(scope): summary commit format, for example fix(header): prevent horizontal overflow; common types include feat, fix, docs, and chore.

Branch from and target master. Keep PRs focused, describe the behavior change, link relevant issues, and report validation commands/results. Include screenshots for visual changes. Follow .github/CONTRIBUTING.md and ensure third-party contributions are appropriately licensed.

Download now (ZIP)

Trending

Steady: 0 new projects took it in the last 4 weeks, none the 4 weeks before.thin data

Week of Aug 30: 0 new projectsWeek of Sep 6: 0 new projectsWeek of Sep 13: 0 new projectsWeek of Sep 20: 0 new projectsWeek of Sep 27: 0 new projectsWeek of Oct 4: 0 new projectsWeek of Oct 11: 0 new projectsWeek of Oct 18: 0 new projects
Aug 2026Sep 2026Oct 2026
New projects taking a version of this file each week, over the 8 weeks our latest run read: only 0 in all, so this is a hint, not a trend.

Who's talking about ColorlibHQ/AdminLTE

The biggest 5 of 95 mentions linking to the repository that our crawl found. Each line is their own headline.

See all 95

Talked about on GitHub, YouTube, Stack Overflow, the web, Hacker News and Bluesky (95 times).

On GitHub · 50

45 more on GitHub

On YouTube · 25

20 more on YouTube

On Stack Overflow · 14

9 more on Stack Overflow

On Hacker News · 1

  • 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 28,693 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.

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
What did you use it for? e.g. Reviewing pull requests in a Rails app

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.

Check your setup, free