Skip to content

Commit 63d5d17

Browse files
authored
Fix typos and improve clarity in documentation files (#120)
This pull request addresses several minor typos and grammatical issues in multiple documentation files: 1. Fixed incorrect use of "a" instead of "an" in the "migrations-guidelines.md" file. 2. Corrected the hyphenation of "up to date" in the "pull-requests.md" file. 3. Corrected the article usage ("a" to "an") in the "extension-e2e-guidelines.md" file. These changes enhance the clarity and correctness of the documentation.
1 parent b5e83f9 commit 63d5d17

3 files changed

Lines changed: 3 additions & 3 deletions

File tree

docs/migrations-guidelines.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Completes the migration by returning the state, modified or not, ensuring a seam
5656
- Always use deep cloning on the old state before passing it to the migration function in tests. For example, use `cloneDeep` from `lodash`.
5757
- Deep cloning preserves the integrity of your test data across different test cases.
5858
- Ensures the original state object is not mutated during the migration process.
59-
- guarantees that each test case runs on an correct, clean copy of the state.
59+
- guarantees that each test case runs on a correct, clean copy of the state.
6060
- Never mutate the state directly as this can:
6161
- lead to hard-to-track bugs and false positives or negatives test results.
6262
- start subsequent tests with the original state as intended.

docs/pull-requests.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ If there are specific changes within your pull request that you'd like to call y
5050

5151
### Create smaller pull requests
5252

53-
Large pull requests are extremely painful to review. They also need to be kept up to date more frequently since they have a higher chance of creating conflicts that need to be resolved, and they make the commit history more difficult to understand after they are merged.
53+
Large pull requests are extremely painful to review. They also need to be kept up-to-date more frequently since they have a higher chance of creating conflicts that need to be resolved, and they make the commit history more difficult to understand after they are merged.
5454

5555
Creating small pull requests starts with creating small issues; break your tasks up into smaller pieces ahead of time whenever possible, to prevent pull requests from growing in size in the first place. If a single task still requires many changes, plan out (or prototype) the code changes that are required, and consider how they can be decomposed into separate changes before marking them as ready for review.
5656

docs/testing/e2e/extension-e2e-guidelines.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -318,7 +318,7 @@ Test Name: Connects to a Hardware wallet for Trezor
318318

319319
## Page Object Model (POM)
320320

321-
POM, or Page Object Model, is a design pattern commonly utilized for writing automated end-to-end tests. A page object is a instance of a class that acts as an interface for the page of the application under test.
321+
POM, or Page Object Model, is a design pattern commonly utilized for writing automated end-to-end tests. A page object is an instance of a class that acts as an interface for the page of the application under test.
322322
This design pattern is being adopted due to its numerous benefits, including improved test maintenance, increased code reusability, and enhanced readability of test scripts. By abstracting the UI details into page objects, changes to the application's UI require updates only in the page objects, significantly reducing the effort needed to maintain tests as the application evolves. The adoption of POM in our e2e testing strategy aims to leverage these advantages to create a more robust, maintainable, and efficient testing framework.
323323

324324
### Composition of a Page Class

0 commit comments

Comments
 (0)