Skip to content
This repository was archived by the owner on Apr 7, 2026. It is now read-only.

docs(testing): Add docs for local testing and contributor test workflow#185

Closed
weiserhase wants to merge 1 commit intol0uisgrange:mainfrom
weiserhase:docs/test-docs
Closed

docs(testing): Add docs for local testing and contributor test workflow#185
weiserhase wants to merge 1 commit intol0uisgrange:mainfrom
weiserhase:docs/test-docs

Conversation

@weiserhase
Copy link
Copy Markdown
Contributor

@weiserhase weiserhase commented Mar 24, 2026

This PR adds documentation for running and maintaining the Typst tests suite locally.

What changed

Added a new testing guide with end-to-end local workflow:

  • running tests
  • prerequisites
  • updating snapshots
  • creating new tests
  • CI parity commands
  • common troubleshooting

Updated contribution docs to:

  • link to the testing guide
  • require running tests before submission

@l0uisgrange
Copy link
Copy Markdown
Owner

Hi @weiserhase 👋,

I think we might be better with PR templates than creating a new README.
That way, people will directly have the commands to run when opening their PR.

Also, I wouldn't put the tytanic docs into the .md, since it already exists into the official tytanic documentation.

Could you instead create a template for PRs and put in it the requirements? For example

  • naming convention for PRs
  • tytanic tests (with a link to tytanic docs)
  • require to put screenshot if new component/changed component (provide a table template with "before->after")
  • ...

@weiserhase
Copy link
Copy Markdown
Contributor Author

@l0uisgrange Yes your right! I will work on this as soon as possible

@weiserhase weiserhase closed this Mar 24, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants