Consolidate E2E test documentation between platforms

Open
#116 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Domain
documentation, testing

Research direction

Compare the unified E2E testing guidelines with the mobile and extension-specific guidelines mentioned in the issue. Consolidate guidance that applies to both platforms, including avoiding arbitrary delays, and ensure the resulting documentation covers the identified gaps without duplicating platform-specific advice.

Written by the indexing model from the issue text.

Description

enhancement

We currently have one unified e2e testing guidelines document, and an additional document for mobile and extension specific guidelines. Most of these platform-specific guidelines are not really platform-specific, and could be adapted to apply to both platforms.

This would fill in some gaps currently in our documentation as well. For example, the mobile E2E test guidelines don't suggest anywhere that we should avoid arbitrary delays, but the extension guidelines do. Arbitrary delays are an anti-pattern that results in slower and more flaky tests, and should be used as a last resort on both platforms, not just extension.

Dominant language
JavaScript
Stars
86
Forks
42
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from MetaMask/contributor-docs

All issues in MetaMask/contributor-docs

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.