From 4586443f1b2bbc3483923b457c637208a269afe7 Mon Sep 17 00:00:00 2001 From: Derek Blank Date: Wed, 10 Jan 2024 09:11:16 +1000 Subject: [PATCH 1/3] docs: Clarify the use of Gutenberg and Gutenberg Mobile repository names See also: 4574af6bad0731ef4e19eaddf74c5da0ba8e6ead --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 78e0ac839d..53f43528bc 100644 --- a/README.md +++ b/README.md @@ -125,11 +125,11 @@ This project is set up to use [jest](https://facebook.github.io/jest/) for tests ## End-to-End Tests -This repository extends the end-to-end (E2E) tests found in the Mobile Gutenberg (MG) [project repository](https://github.com/WordPress/gutenberg). The majority of E2E tests should reside in the MG repository. However, experimental tests or non-core-related tests should be placed in the `gutenberg-mobile` repository. +This repository extends the end-to-end (E2E) tests found in the [Gutenberg project repository](https://github.com/WordPress/gutenberg). The majority of E2E tests should reside in the `gutenberg` repository. However, experimental tests or non-core-related tests should be placed in the `gutenberg-mobile` repository. -Reviewing the MG E2E test [documentation](https://github.com/WordPress/gutenberg/tree/trunk/packages/react-native-editor/__device-tests__#readme) is the best approach for understanding the test environment and how to set up your computer to run tests. Much of the information and approaches outlined there also apply to the tests found in this repository. The only difference being that this repository includes its own matching npm scripts to run the test, e.g. `npm run test:e2e:ios:local`. +Reviewing the [Mobile Gutenberg E2E test documentation](https://github.com/WordPress/gutenberg/tree/trunk/packages/react-native-editor/__device-tests__#readme) is the best approach for understanding the test environment and how to set up your computer to run tests. Much of the information and approaches outlined there also apply to the tests found in this repository. The only difference being that this repository includes its own matching npm scripts to run the test, e.g. `npm run test:e2e:ios:local`. -After reviewing the MG E2E test documentation, the following examples showcase running the E2E tests found in this repository using the repositories scripts. +After reviewing the Mobile Gutenberg E2E test documentation, the following examples showcase running the E2E tests found in this repository using the repositories scripts. ```shell # Setup the E2E environment From 1631f4ac77be803b365ed1c186c1d40ed0efd267 Mon Sep 17 00:00:00 2001 From: David Calhoun Date: Wed, 10 Jan 2024 09:16:44 -0500 Subject: [PATCH 2/3] docs: Improve project name consistency Attempt to mitigate confusion between the `gutenberg` and `gutenberg-mobile` repositories, in addition to the general "Gutenberg" project and plugin. --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 53f43528bc..e7bde48468 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # Mobile Gutenberg -This repository represents the mobile version of the WordPress [Gutenberg](https://github.com/WordPress/gutenberg) project, targeting Android and iOS platforms using React Native. +This repository represents the mobile version of the WordPress [`gutenberg`](https://github.com/WordPress/gutenberg) project, targeting Android and iOS platforms using React Native. -![Screenshot of the Mobile Gutenberg Editor, editing a post in WordPress](https://github.com/wordpress-mobile/gutenberg-mobile/assets/643285/db32a1b1-e149-4aab-aa81-01392f974aef) +![Screenshot of the mobile Gutenberg editor, editing a post in WordPress](https://github.com/wordpress-mobile/gutenberg-mobile/assets/643285/db32a1b1-e149-4aab-aa81-01392f974aef) ## Getting Started @@ -93,7 +93,7 @@ Some times, and especially when tweaking anything in the `package.json`, Babel c ## Developing with Visual Studio Code -Although you're not required to use Visual Studio Code for developing gutenberg-mobile, it is the recommended IDE and we have some configuration for it. +Although you're not required to use Visual Studio Code for developing `gutenberg-mobile`, it is the recommended IDE and we have some configuration for it. When you first open the project in Visual Studio, you will be prompted to install some recommended extensions. This will help with some things like type checking and debugging. @@ -125,11 +125,11 @@ This project is set up to use [jest](https://facebook.github.io/jest/) for tests ## End-to-End Tests -This repository extends the end-to-end (E2E) tests found in the [Gutenberg project repository](https://github.com/WordPress/gutenberg). The majority of E2E tests should reside in the `gutenberg` repository. However, experimental tests or non-core-related tests should be placed in the `gutenberg-mobile` repository. +This repository extends the end-to-end (E2E) tests found in the [`gutenberg` project repository](https://github.com/WordPress/gutenberg). The majority of E2E tests should reside in the `gutenberg` repository. However, experimental tests or non-core-related tests should be placed in the `gutenberg-mobile` repository. -Reviewing the [Mobile Gutenberg E2E test documentation](https://github.com/WordPress/gutenberg/tree/trunk/packages/react-native-editor/__device-tests__#readme) is the best approach for understanding the test environment and how to set up your computer to run tests. Much of the information and approaches outlined there also apply to the tests found in this repository. The only difference being that this repository includes its own matching npm scripts to run the test, e.g. `npm run test:e2e:ios:local`. +Reviewing the [`gutenberg` E2E test documentation](https://github.com/WordPress/gutenberg/tree/trunk/packages/react-native-editor/__device-tests__#readme) is the best approach for understanding the test environment and how to set up your computer to run tests. Much of the information and approaches outlined there also apply to the tests found in this repository. The only difference being that this repository includes its own matching npm scripts to run the test, e.g. `npm run test:e2e:ios:local`. -After reviewing the Mobile Gutenberg E2E test documentation, the following examples showcase running the E2E tests found in this repository using the repositories scripts. +After reviewing the `gutenberg` E2E test documentation, the following examples showcase running the E2E tests found in this repository using the repositories scripts. ```shell # Setup the E2E environment @@ -144,7 +144,7 @@ npm run test:e2e:android:local -- --watch ## Static analysis and code style -The project includes a linter (`eslint`) to perform codestyle and static analysis of the code. The configuration used is the same as [the one in the Gutenberg project](https://github.com/WordPress/gutenberg/blob/HEAD/packages/eslint-plugin/README.md). To perform the check, run: +The project includes a linter (`eslint`) to perform codestyle and static analysis of the code. The configuration used is the same as [the one in the `gutenberg` project](https://github.com/WordPress/gutenberg/blob/HEAD/packages/eslint-plugin/README.md). To perform the check, run: ``` npm run lint @@ -156,7 +156,7 @@ You might want to use Visual Studio Code as an editor. The project includes the ## Internationalization (i18n) -The support for i18n in the project is provided by three main areas for the different plugins included in Gutenberg Mobile: +The support for i18n in the project is provided by three main areas for the different plugins included in `gutenberg-mobile`: 1. Translations files download 2. Locale setup @@ -261,4 +261,4 @@ This can be produced by several causes, check the following steps in order to id ## License -Gutenberg Mobile is an Open Source project covered by the [GNU General Public License version 2](LICENSE). +`gutenberg-mobile` is an Open Source project covered by the [GNU General Public License version 2](LICENSE). From d889a3dac4bbe6354d6d470aaecedfe9ac7dcfef Mon Sep 17 00:00:00 2001 From: David Calhoun Date: Wed, 10 Jan 2024 09:22:45 -0500 Subject: [PATCH 3/3] docs: Clarify the current reality of E2E test locations It is better to describe the current state, rather than an ideal. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e7bde48468..09f448ec95 100644 --- a/README.md +++ b/README.md @@ -125,7 +125,7 @@ This project is set up to use [jest](https://facebook.github.io/jest/) for tests ## End-to-End Tests -This repository extends the end-to-end (E2E) tests found in the [`gutenberg` project repository](https://github.com/WordPress/gutenberg). The majority of E2E tests should reside in the `gutenberg` repository. However, experimental tests or non-core-related tests should be placed in the `gutenberg-mobile` repository. +This repository extends the end-to-end (E2E) tests found in the [`gutenberg` project repository](https://github.com/WordPress/gutenberg). The majority of E2E tests reside in the `gutenberg-mobile` repository due to technical challenges, such as long runtime durations and instability. Additionally, experimental tests or non-core-related tests should be placed in the `gutenberg-mobile` repository. Reviewing the [`gutenberg` E2E test documentation](https://github.com/WordPress/gutenberg/tree/trunk/packages/react-native-editor/__device-tests__#readme) is the best approach for understanding the test environment and how to set up your computer to run tests. Much of the information and approaches outlined there also apply to the tests found in this repository. The only difference being that this repository includes its own matching npm scripts to run the test, e.g. `npm run test:e2e:ios:local`.