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

Docs: Instructions on how to write E2E tests for app plugins #891

Merged
merged 6 commits into from
May 21, 2024

Conversation

mckn
Copy link
Collaborator

@mckn mckn commented Apr 24, 2024

What this PR does / why we need it:
This PR provides some instructions on how to structure your E2E tests for app plugins. Hopefully it show case two different patterns for improving readability and to make it easier to share logic between tests.

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:
This is a rough draft so feel free to provide bigger text changes that would make it easier to understand the documentation.

Copy link

github-actions bot commented Apr 24, 2024

Hello! 👋 This repository uses Auto for releasing packages using PR labels.

✨ This PR can be merged. It will not be considered when calculating future versions of the npm packages and will not appear in the changelogs.

@mckn mckn self-assigned this Apr 24, 2024
@mckn mckn added minor Increment the minor version when merged no-changelog Don't include in changelog and version calculations type/docs Changes only affect the documentation and removed minor Increment the minor version when merged labels Apr 25, 2024
@mckn mckn marked this pull request as ready for review April 25, 2024 20:31
@mckn mckn requested a review from a team as a code owner April 25, 2024 20:31
@mckn mckn requested review from Ukochka, sunker and josmperez and removed request for a team April 25, 2024 20:31
Copy link
Contributor

@josmperez josmperez left a comment

Choose a reason for hiding this comment

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

Hi @mckn - Please take a look at my suggestions in my recent commits related to doc style, clarity, and so on. Many of these are related to doc style preference for simple indicative tense and avoidance of gerunds. Let me know if you have any questions.

@tolzhabayev tolzhabayev mentioned this pull request May 8, 2024
6 tasks
@mckn
Copy link
Collaborator Author

mckn commented May 16, 2024

Hi @mckn - Please take a look at my suggestions in my recent commits related to doc style, clarity, and so on. Many of these are related to doc style preference for simple indicative tense and avoidance of gerunds. Let me know if you have any questions.

Love it! There is only one thing that I would like to change. I'm adding a comment with your name to it so we can discuss it in this PR. Hope that is ok 🙏🏻

Co-authored-by: Marcus Andersson <marcus.andersson@grafana.com>
Copy link
Contributor

@josmperez josmperez left a comment

Choose a reason for hiding this comment

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

LGTM.

Copy link
Contributor

@sunker sunker 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 on this @mckn!

@mckn mckn merged commit 7d2dc68 into main May 21, 2024
12 checks passed
@mckn mckn deleted the mckn/added-apps-docs branch May 21, 2024 06:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-changelog Don't include in changelog and version calculations type/docs Changes only affect the documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

3 participants