Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

Type-check the TypeScript samples in the docs

Ouverte
  • Quelque chose ne va pas ?
#201 7 commentaires 0 réactions 1 personne assignée Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

@An16og y travaille déjà.

Depuis le 21/10/2026.

  • #295 par @An16og — ouverte

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
70/100
Type d'issue
Fonctionnalité
Clarté
Clairement spécifiée
Activité
Active
Stack technique
github-actions, node.js, typescript
Domaine
ci-cd, documentation, testing, tooling

Piste de recherche

Read CONTRIBUTING.md for the pnpm setup and build steps, then inspect the TypeScript blocks in website/src/content/docs/**/*.mdx and the CI workflow. Add a checker that extracts and type-checks the samples against the built packages, supports // docs-check: skip, and reports file and line; add docs:check to CI and fix flagged samples. Done when pnpm docs:check passes on dev, reports checked and skipped counts, and a deliberately broken sample fails with its location.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

documentation hacktoberfest help wanted testing

The docs have 67 typescript code blocks across website/src/content/docs/**/*.mdx, and nothing checks that they still compile against the packages. Past PRs (#52, #135) fixed samples that imported paths that don't exist and called constructors the wrong way; the next API change will break some again without anyone noticing.

What to do

  • Add a script, for example scripts/check-doc-samples.mjs, that pulls every ```typescript block out of the .mdx files, writes each to a temporary `.ts` file, and type-checks them with `tsc --noEmit` against the built packages (`@chatcops/core`, `@chatcops/server`, `@chatcops/widget`).
  • Blocks that are fragments on purpose (a config object on its own, a type signature) can opt out with a // docs-check: skip first line. Keep the opt-outs few, and prefer making a sample complete.
  • Add a docs:check script and run it in CI after the build.
  • Fix the samples it flags.

Acceptance criteria

  • pnpm docs:check runs on dev and passes, with the number of checked and skipped blocks printed
  • Breaking a sample on purpose (put the diff in the PR description) makes it fail with the file and line
  • CI runs it
  • No changeset needed (tooling and docs)

Want to work on this? Comment below and I'll assign it to you. Please take one issue at a time, branch off dev, and open your PR against dev with Closes #<this issue number>. Setup notes (pnpm, build before test) are in CONTRIBUTING.md.

Langage dominant
TypeScript
Étoiles
13
Forks
7
Merge moyen
3 h 33 min
PR mergées (30 j)
176

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de codercops/chatcops

Toutes les issues de codercops/chatcops

Issues similaires

Plus d'issues TypeScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.