Skip to content

Commit 2d67ec9

Browse files
committed
Update Best Practices
1 parent 3f7df8b commit 2d67ec9

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

docs/best-practices.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ Check out our best practices below to ensure you are getting the absolute most o
55
## Action group
66

77
1. [Action group] names should be sufficiently descriptive to inform a test writer of what the action group does and when it should be used.
8-
Add additional explanation in comments if needed.
8+
Add additional explanation in annotations if needed.
99
2. Provide default values for the arguments that apply to your most common case scenarios.
1010

1111
## `actionGroups` vs `extends`
1212

13-
Use an action group to wraps a set of actions to reuse them multiple times.
13+
Use an action group to wrap a set of actions to reuse them multiple times.
1414

1515
Use an [extension] when a test or action group needs to be repeated with the exception of a few steps.
1616

@@ -64,6 +64,12 @@ Format: {_Admin_ or _Storefront_}{Functionality}_Test.xml_, where Functionality
6464

6565
Example: _StorefrontCreateCustomerTest.xml_.
6666

67+
#### Action Group file name
68+
69+
Format: {_Admin_ or _Storefront_}{Action Group Summary}ActionGroup.xml`, where Action Group Summary describes with a few words what we can expect from it.
70+
71+
Example: _AdminCreateStoreActionGroup.xml_
72+
6773
#### Section file name
6874

6975
Format: {_Admin_ or _Storefront_}{UI Description}_Section.xml_, where UI Description briefly describes the testing UI.
@@ -97,6 +103,7 @@ Use a lower case first letter for:
97103

98104
- Data keys. Example: `<data key="firstName">`.
99105
- Element names. Examples: `<element name="confirmDeleteButton"/>`.
106+
- Step keys. For example: `<click selector="..." stepKey="clickLogin"/>`
100107

101108
## Page object
102109

0 commit comments

Comments
 (0)