Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add test tools docs #167

Merged
merged 12 commits into from
Oct 10, 2024

Conversation

hampuslavin
Copy link
Contributor

@hampuslavin hampuslavin commented Oct 2, 2024

Descrption / reasoning

The idea is to divide into different pages that has different focus areas. Currently I have the following in mind:

  • Get started: Easily digested get started info, minimum for getting the simplest test to run
  • The basics: Additional documentation you will absolutely need to know within "the first hour" of writing tests
  • Advanced exmples: More complex test setup examples. Can still be common cases but not something you necessarily need to write a first test suite.
  • Best practises: Inspired by Cypress' (e2e web test framework) best practices page, as inevitably there will always be cases where a user can do a thing in multiple ways. I've found the Cypress page to be tremendously helpful over the years. It also helps to educate and onboard team members who are new to a framework to quickly get into the "philosophy" of the tool.
image

❓ TODO / Question for reviewer:

  • Consider what more best practises to add. Maybe some general testing principles that applied outside of Serverpod as well?

@hampuslavin hampuslavin changed the title feat: Add test tools docs [WIP] feat: Add test tools docs Oct 2, 2024
@hampuslavin hampuslavin force-pushed the hl_add_test_tools_docs branch 3 times, most recently from 5a17cda to e117280 Compare October 7, 2024 17:16
Copy link
Contributor

@SandPod SandPod left a comment

Choose a reason for hiding this comment

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

Awesome work!

I like the structure presented here, have a couple of comments for different sections.
Ping me if anything is unclear!

docs/06-concepts/18-testing/01-get-started.md Show resolved Hide resolved
docs/06-concepts/18-testing/01-get-started.md Outdated Show resolved Hide resolved
docs/06-concepts/18-testing/01-get-started.md Show resolved Hide resolved
docs/06-concepts/18-testing/01-get-started.md Outdated Show resolved Hide resolved
docs/06-concepts/18-testing/01-get-started.md Outdated Show resolved Hide resolved
docs/06-concepts/18-testing/02-the-basics.md Outdated Show resolved Hide resolved
docs/06-concepts/18-testing/02-the-basics.md Outdated Show resolved Hide resolved
docs/06-concepts/18-testing/02-the-basics.md Outdated Show resolved Hide resolved
docs/06-concepts/18-testing/02-the-basics.md Show resolved Hide resolved
docs/06-concepts/18-testing/04-best-practises.md Outdated Show resolved Hide resolved
Copy link
Contributor

@SandPod SandPod left a comment

Choose a reason for hiding this comment

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

Some more minor NITs, do you want to convert this to a PR instead of it being a draft?

docs/06-concepts/18-testing/02-the-basics.md Outdated Show resolved Hide resolved
@hampuslavin hampuslavin marked this pull request as ready for review October 8, 2024 09:46
@hampuslavin hampuslavin changed the title [WIP] feat: Add test tools docs feat: Add test tools docs Oct 8, 2024
Copy link
Contributor

@SandPod SandPod left a comment

Choose a reason for hiding this comment

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

Couple of minor last comments!

Then I think this is good enough to release :)

docs/06-concepts/18-testing/02-the-basics.md Outdated Show resolved Hide resolved
docs/06-concepts/18-testing/02-the-basics.md Outdated Show resolved Hide resolved
Copy link
Contributor

@SandPod SandPod left a comment

Choose a reason for hiding this comment

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

Great work!

I think this looks good to me! :D Let's test it out and see if people understand it :)

@hampuslavin hampuslavin merged commit 18193f7 into serverpod:main Oct 10, 2024
2 checks passed
@hampuslavin hampuslavin deleted the hl_add_test_tools_docs branch October 10, 2024 07:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants