Skip to content

Adds a tutorial on how to write tests with lute#890

Open
Vighnesh-V wants to merge 2 commits intoprimaryfrom
lute-test-docs
Open

Adds a tutorial on how to write tests with lute#890
Vighnesh-V wants to merge 2 commits intoprimaryfrom
lute-test-docs

Conversation

@Vighnesh-V
Copy link
Collaborator

This PR adds documentation that summarizes a) how to write tests, b) how to run tests, c) how to organize your tests using suites.

I've also explicitly called out testing as part of the cool developer tooling we've built, and linked it in the CLI reference. The plan for the Developer Tooling section is to extend it with blurbs about lute lint, lute check, and lute compile (and any others that we add).

@Vighnesh-V Vighnesh-V self-assigned this Mar 20, 2026
@Vighnesh-V Vighnesh-V added the documentation Improvements or additions to documentation label Mar 20, 2026
@Vighnesh-V Vighnesh-V added this to the Release A milestone Mar 20, 2026
@Vighnesh-V Vighnesh-V changed the title Adds a tutorial on how to write tests to lute Adds a tutorial on how to write tests with lute Mar 20, 2026
Copy link
Member

@aatxe aatxe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you line wrap paragraphs at 100 or 80 or something? It'll make diffs much better in the future, and makes it easier to leave comments.

@Vighnesh-V
Copy link
Collaborator Author

I've gone ahead and auto wrapped all the text to 80 columns. I have also retroactively done this to the docs I added in the previous two PRs as part of this PR. Feel free to review and leave comments, but most of the changes I made were in the dev-tooling/ and writing-tests/ directory.

Also, the reason writing-tests/ is a directory is because I am going to add some documentation for snapshot testing.

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

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants