Skip to content

ドキュメントとテストを対応関係にする #438

Description

@FineArchs

ドキュメントファイル(.md)とテストコード(.ts)を、それぞれお互いに同名の対応するファイルがあるようにしたいと考えています。

// 例
doc/
  get-started.md, syntax.md, std.md, std-math.md, primitive-props.md
  parser/
    scanner.md

test/
  get-started.ts, syntax.ts, std.ts, std-math.ts, primitive-props.ts, parser.ts
  // パーサーのドキュメント・テストはひとまず現状維持とする

Pros

  • テストが探しやすくなる。
  • 足りていないテストを確認しやすくなる。

Cons

  • ややテスト時間が伸びる?
  • ややメンテナンスコストが上がる?

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions