Skip to content

TS Conformance: documentation update (README, STATUS.md, CLAUDE.md) #89

@nickna

Description

@nickna

Part of #80. Depends on #85.

Goal

Document the new conformance corpus so future contributors know what it is, when it runs, and how to update its baseline.

Work

  • README.md — add a section under existing testing docs:
    • What the corpus is (microsoft/TypeScript at pinned tag)
    • How to init the submodule
    • How to run locally (dotnet test SharpTS.TypeScriptConformance/...)
    • How to update the baseline (SHARPTS_TSCONFORMANCE_UPDATE_BASELINE=1)
  • STATUS.md — add the TS conformance pass rate alongside Test262 numbers; note the subset scope.
  • CLAUDE.md — short pointer in the testing section so future Claude sessions know the runner exists and the bucket model. One line + link to the README section.
  • SharpTS.TypeScriptConformance/README.md — project-local doc explaining the directive parser, baseline format, and skip-directives file (mirror SharpTS.Test262/'s README if one exists, otherwise create one for both).

Acceptance

  • A new contributor can clone the repo, run the conformance suite, and update the baseline without asking questions.
  • Pass-rate number in STATUS.md matches what the runner produces.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions