Custom Tests specification documentation #69
Conversation
| @@ -0,0 +1,78 @@ | |||
| # Other Frameworks | |||
|
|
|||
| QIT Custom E2E Tests **uses Playwright by default, but it is framework-agnostic by design**. Runners that emit **[CTRF](https://ctrf.io)** results can be integrated, although such setups are considered *experimental* and must be maintained by the implementer. | |||
There was a problem hiding this comment.
This sentence is correct but it sounds a bit rigid and explicit:
Runners that emit **[CTRF](https://ctrf.io)** results can be integrated, although such setups are considered *experimental* and must be maintained by the implementer.
Maybe we can turn it into an opportunity to build community around the custom tests?:
You can integrate any test runner that provides [CTRF](https://ctrf.io/) reports, but only Playwright will be officially supported . Community-maintained integrations are welcome!
|
|
||
| ### 2. Integration steps | ||
|
|
||
| **Create `qit-e2e.json`** |
There was a problem hiding this comment.
I would keep the titles more descriptive than super accurate. For example, here I would say something like:
Create a specification file.
We're mentioning later that you need to add a qit-e2e.json file so I don't think we need to repeat it in the title.
Also, I think this line serves as a title, maybe we can replace the bold syntax with a minor title? Something like:
##### Create a specification file
|
|
||
| **Create `qit-e2e.json`** | ||
|
|
||
| In the **root of your test directory** (where your test framework’s config typically lives), add a `qit-e2e.json` file. QIT relies on this file to know how to set up and run your tests. Start with an example like this: |
There was a problem hiding this comment.
Would it help if we added an example of a test path for devs to see what this folder would look like and how the qit-e2e.json file should be placed in relation to this folder?
| } | ||
| ``` | ||
|
|
||
| See more options for the `qit-e2e.json` file in the [specification](../specification.md). |
There was a problem hiding this comment.
I'd try to reference to this file as the specification in order to establish our own knowledge base of the entities that are part of the QIT architecture. We could say something like:
See more configuration options in the [specification](../specification.md).
|
|
||
| From your WordPress plugin or theme directory, run: | ||
|
|
||
| ```qitbash |
There was a problem hiding this comment.
In all these sections we provide instructions on how to proceed by suggesting commands in the terminal. Apart from these instructions, would it be good if we provided an example in order to remove any minimal potential doubt users might have?
Apologies if I'm too pushy with examples 😆 I just believe they're one of the best ways to learn something new, which would be good to keep our documentation easy to understand both for experienced and new developers, or even vibe coders / no-coders.
This PR is a working-in-progress, and a description will be added when it's ready for review.