Docs: "Test your bot before launch" guide

Offen
  • Stimmt etwas nicht?
#555 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
72/100
Issue-Typ
Dokumentation
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
github-actions, typescript, yaml
Bereich
documentation

Rechercherichtung

Read website/src/content/docs/core/testing.mdx for the documented eval assertions and GitHub Actions workflow, then check the eval schema in packages/cli/src/test/load.ts. Add the specified guide at website/src/content/docs/getting-started/test-before-launch.mdx, update website/astro.config.mjs and link to it near the top of testing.mdx. Done means the examples and recorded replay are verified, and the docs check and website build pass.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

documentation

F-07 task 19. chatcops test is documented as a reference in website/src/content/docs/core/testing.mdx: eval files at line 35, the judge at 124, costs at 177, recorded replays at 221, and a GitHub Actions example at 256. What's missing is a guide someone can follow before launch: from no tests to a suite that runs on every pull request for free.

What to do

A new page, website/src/content/docs/getting-started/test-before-launch.mdx, added to the Getting Started sidebar in website/astro.config.mjs after "Index Your Site". It has these steps:

  1. Write the first eval file: three to five questions your bot has to get right, such as pricing, a lead being captured, and an off-topic question it should decline. Use contains, calls-tool, lead-captured and one judge assertion. testing.mdx lists them all.
  2. Run it live with npx chatcops test, and read the pretty output and a failure.
  3. Record it with --record, commit evals/__cassettes__/, and explain why replay is free and the same every time.
  4. Run it in CI: the workflow from testing.mdx:256, replaying on every PR with no API keys. When a prompt change breaks replay, re-record.
  5. Add a simulated visitor (simulate, #512) for one multi-turn case.

End with a short "What to test" list for a typical site bot.

Acceptance criteria

  • The page is in the sidebar. Every TypeScript block passes pnpm docs:check, and every YAML example matches the eval file schema (packages/cli/src/test/load.ts).
  • You ran the example eval file yourself against a bot (any provider), recorded it, and ran it again with --replay. Say in the PR what you ran.
  • testing.mdx links to the new page near the top.
  • pnpm --filter @chatcops/website build passes. Docs only, so no changeset.

Comment here to be assigned.

Vorherrschende Sprache
TypeScript
Sterne
13
Forks
7
Ø Merge
3 Std. 10 Min.
Gemergte PRs (30 T.)
339

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus codercops/chatcops

Alle Issues in codercops/chatcops

Ähnliche Issues

Weitere Issues zu TypeScript

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.