Skip to content

(docs): add best practices guide#11071

Merged
erwinheitzman merged 18 commits intowebdriverio:mainfrom
erwinheitzman:docs-add-best-practices-guide
Sep 7, 2023
Merged

(docs): add best practices guide#11071
erwinheitzman merged 18 commits intowebdriverio:mainfrom
erwinheitzman:docs-add-best-practices-guide

Conversation

@erwinheitzman
Copy link
Member

Proposed changes

I've written an extensive best practices guide based on my knowledge and experience. I do not think it is done and am planning to extend it at some point but I believe this to be a great start that can help our users to write better tests.

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

Checklist

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)
  • I have added proper type definitions for new commands (if appropriate)

Reviewers: @webdriverio/project-committers

Copy link
Member

@christian-bromann christian-bromann left a comment

Choose a reason for hiding this comment

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

This is a great start to begin collecting best practices. Add my two cents.

@erwinheitzman
Copy link
Member Author

I think I resolved all the feedback 👍

erwinheitzman and others added 4 commits September 6, 2023 17:23
Co-authored-by: Christian Bromann <git@bromann.dev>
Co-authored-by: Christian Bromann <git@bromann.dev>
Co-authored-by: Christian Bromann <git@bromann.dev>
@erwinheitzman
Copy link
Member Author

Thanks for all the great feedback Christian!

Copy link
Member

@christian-bromann christian-bromann left a comment

Choose a reason for hiding this comment

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

LGTM 👍 great job!

@christian-bromann christian-bromann added the PR: Docs 📝 PRs that contain changes to the documentation label Sep 6, 2023
@erwinheitzman erwinheitzman merged commit 793903c into webdriverio:main Sep 7, 2023
@erwinheitzman erwinheitzman deleted the docs-add-best-practices-guide branch September 7, 2023 11:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

PR: Docs 📝 PRs that contain changes to the documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants