agentleFS
apacheapache/hertzbeat/web-app/AGENTS.md

hertzbeat / web-app

AGENTS.md7.5k starsChanged 17 months agoApache-2.0View on GitHub

This directory contains the active HertzBeat 2.0 frontend: Vite, React 18, Refine 5, Ant Design 5, TanStack Query 5, and React Router 7. Do not restore Next.js or Angular conventions and do not create another frontend project. Use the former Angular web-app as a HertzBeat organization reference: keep API access out of UI, routes explicit, models discoverable, shared components central, and i18n unified. Translate those responsibilities into the React feature layers in architecture.md; do not copy Angular modules, RxJS subscription…

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

13 rules. About 0 are common, 4 are distinctive, and 9 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈4

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 9

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Use the former Angular web-app as a HertzBeat organization reference: keep API access out of UI, routes explicit, models discoverable, …

    line 7
  2. Very specific:

    Before editing source, read architecture.md completely and inspect git status --short.

    line 13
  3. Very specific:

    place transport and runtime schemas in features/<domain>/api.

    line 25
  4. Very specific:

    place pure domain and URL state in model.

    line 26
  5. Very specific:

    place React/Refine/TanStack orchestration in controller.

    line 27
  6. Very specific:

    keep pages thin and components presentational.

    line 28
  7. Distinctive:

    write the smallest failing test before implementation.

    line 30
  8. Distinctive:

    run focused verification before broader verification.

    line 31
  9. Very specific:

    update the ignored root progress.md after each milestone.

    line 32
  10. Very specific:

    Do not declare a wire or visible workflow complete from green TypeScript and unit tests alone.

    line 34
  11. Distinctive:

    Use Node 22 and pnpm 10. Run:

    line 40
  12. Distinctive:

    When an upstream context changes (time range, service, environment, Collector, language, framework, or method), clear dependent evidence …

    line 58
  13. Very specific:

    Use HertzBeat's rendered shell and global --hb-* tokens as the visual source of truth.

    line 65

≈ “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

HertzBeat React agent guide

This directory contains the active HertzBeat 2.0 frontend: Vite, React 18, Refine 5, Ant Design 5, TanStack Query 5, and React Router 7. Do not restore Next.js or Angular conventions and do not create another frontend project.

Use the former Angular web-app as a HertzBeat organization reference: keep API access out of UI, routes explicit, models discoverable, shared components central, and i18n unified. Translate those responsibilities into the React feature layers in architecture.md; do not copy Angular modules, RxJS subscription code, global service growth, any DTOs, or oversized components.

Before editing source, read architecture.md completely and inspect git status --short. Preserve every existing staged, unstaged, and untracked change. Do not use reset, stash, clean, or checkout-based rollback.

For every non-trivial change, read the current path end to end before writing: route/page -> controller -> model/API -> backend response contract -> rendered consumer. Current source and the live backend are authoritative; comments, plans, screenshots, Angular, and Horizon are references. If a new local pattern seems necessary, first confirm the surrounding feature does not already own it.

Work one vertical slice at a time:

  1. place transport and runtime schemas in features/<domain>/api;
  2. place pure domain and URL state in model;
  3. place React/Refine/TanStack orchestration in controller;
  4. keep pages thin and components presentational;
  5. expose cross-feature use only through the feature index.ts;
  6. write the smallest failing test before implementation;
  7. run focused verification before broader verification;
  8. update the ignored root progress.md after each milestone.

Do not declare a wire or visible workflow complete from green TypeScript and unit tests alone. Run it against the real HertzBeat backend and inspect the actual request, response, route transition, and rendered state. If the backend or required data is unavailable, record that proof as a blocker; never invent a payload, fake healthy data, or silently substitute a mock.

Use Node 22 and pnpm 10. Run:

pnpm architecture
pnpm lint
pnpm typecheck
pnpm test
pnpm build
pnpm i18n:check
pnpm budget
pnpm dead-code

Visible UI work additionally requires a production build, real backend, and in-app Browser verification at a fixed viewport. Keep screenshots and reports under .tmp; never commit them, progress.md, dist, coverage, logs, test databases, or local proof data.

When an upstream context changes (time range, service, environment, Collector, language, framework, or method), clear dependent evidence before loading the new scope and show an explicit loading state. Never leave stale values visible under a spinner. Every link or programmatic navigation must resolve through the central route registry, and route parameters consumed on mount need a test for the direct-entry path as well as in-app navigation.

Use HertzBeat's rendered shell and global --hb-* tokens as the visual source of truth. Horizon informs density, hierarchy, and interaction discipline; it does not authorize copying its Vue structure, branding, or OAP-specific rules. Comments document only a public contract or a non-obvious invariant. Do not paraphrase control flow or leave implementation history in source comments.

Instrumentation is an onboarding workflow. It consumes the Collector v1 catalog/render/detect contract and renders structured guidance. Never copy, rename, download, or package a language SDK or Agent binary into HertzBeat. Token values remain in the minimum in-memory state and never enter URLs, local storage, logs, analytics, snapshots, or persisted progress.

Download now (ZIP)

Trending

Steady talk.about the whole repository

Dec 2025: 0 mentionsJan 2026: 0 mentionsFeb 2026: 0 mentionsMar 2026: 0 mentionsApr 2026: 0 mentionsMay 2026: 1 mentionJun 2026: 0 mentionsJul 2026: 0 mentionsAug 2026: 1 mentionSep 2026: 0 mentionsOct 2026: 1 mentionNov 2026: 0 mentions
Dec 2025Jun 2026Nov 2026
Mentions a month of the apache/hertzbeat repository that our weekly crawl found. There is no adoption data for this file yet.

Who's talking about apache/hertzbeat

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

See all 23

Talked about on GitHub, Hacker News and Bluesky (23 times).

On GitHub · 19

14 more on GitHub

On Hacker News · 2

  • 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.