`TF004` Add comments¶

Write a comment file to add comments to requirements

Initial state¶

The expected state is the final state of TF002 Generate a PDF

Procedure¶

Step 1¶

Create a comment file

$ cat comments.yaml

kind: comments
comments:
- about: RF01
  from: Some Person
  date: 01/01/2025
  text: The first comment
- about: RF02
  from: Some "other" Person
  date: 02/01/2025
  text: A second comment

Step 2¶

Add it to the typst source

$ cat specification.typ

#import "@local/speky:0.1.2": speky
#speky(("requirements.yaml", "tests.yaml", "comments.yaml").map(yaml))

Step 3¶

Regenerate the PDF and open it

$ typst compile specification.typ --open

Step 4¶

Verify the comments appear in requirements RF01 and RF02, in the “Comments” subsection.

TF004 Add comments¶