From 52f6f1dce809c6ee0d8985426d5828b8fe961f00 Mon Sep 17 00:00:00 2001
From: Joseph Baylon <joseph.baylon@mattermost.com>
Date: Tue, 13 Oct 2020 20:24:16 -0700
Subject: [PATCH] Added missing comment guideline (#4889)

---
 detox/e2e/test/autocomplete/edit_channel.e2e.js | 6 ++++++
 detox/e2e/test/autocomplete/edit_post.e2e.js    | 6 ++++++
 detox/e2e/test/autocomplete/post_draft.e2e.js   | 6 ++++++
 detox/e2e/test/autocomplete/search.e2e.js       | 6 ++++++
 detox/e2e/test/smoke_test/channels.e2e.js       | 6 ++++++
 detox/e2e/test/smoke_test/login_ldap.e2e.js     | 6 ++++++
 6 files changed, 36 insertions(+)

diff --git a/detox/e2e/test/autocomplete/edit_channel.e2e.js b/detox/e2e/test/autocomplete/edit_channel.e2e.js
index 5e7418763..d15ac5509 100644
--- a/detox/e2e/test/autocomplete/edit_channel.e2e.js
+++ b/detox/e2e/test/autocomplete/edit_channel.e2e.js
@@ -1,6 +1,12 @@
 // Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
 // See LICENSE.txt for license information.
 
+// *******************************************************************
+// - [#] indicates a test step (e.g. # Go to a screen)
+// - [*] indicates an assertion (e.g. * Check the title)
+// - Use element testID when selecting an element. Create one if none.
+// *******************************************************************
+
 import {toChannelScreen} from '@support/ui/screen';
 
 import {Setup} from '@support/server_api';
diff --git a/detox/e2e/test/autocomplete/edit_post.e2e.js b/detox/e2e/test/autocomplete/edit_post.e2e.js
index b78a710e7..a200db4dd 100644
--- a/detox/e2e/test/autocomplete/edit_post.e2e.js
+++ b/detox/e2e/test/autocomplete/edit_post.e2e.js
@@ -1,6 +1,12 @@
 // Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
 // See LICENSE.txt for license information.
 
+// *******************************************************************
+// - [#] indicates a test step (e.g. # Go to a screen)
+// - [*] indicates an assertion (e.g. * Check the title)
+// - Use element testID when selecting an element. Create one if none.
+// *******************************************************************
+
 import {toChannelScreen} from '@support/ui/screen';
 
 import {Setup} from '@support/server_api';
diff --git a/detox/e2e/test/autocomplete/post_draft.e2e.js b/detox/e2e/test/autocomplete/post_draft.e2e.js
index e5315372b..d5d2479f3 100644
--- a/detox/e2e/test/autocomplete/post_draft.e2e.js
+++ b/detox/e2e/test/autocomplete/post_draft.e2e.js
@@ -1,6 +1,12 @@
 // Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
 // See LICENSE.txt for license information.
 
+// *******************************************************************
+// - [#] indicates a test step (e.g. # Go to a screen)
+// - [*] indicates an assertion (e.g. * Check the title)
+// - Use element testID when selecting an element. Create one if none.
+// *******************************************************************
+
 import {toChannelScreen} from '@support/ui/screen';
 
 import {Setup} from '@support/server_api';
diff --git a/detox/e2e/test/autocomplete/search.e2e.js b/detox/e2e/test/autocomplete/search.e2e.js
index 70b0a8807..577922f74 100644
--- a/detox/e2e/test/autocomplete/search.e2e.js
+++ b/detox/e2e/test/autocomplete/search.e2e.js
@@ -1,6 +1,12 @@
 // Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
 // See LICENSE.txt for license information.
 
+// *******************************************************************
+// - [#] indicates a test step (e.g. # Go to a screen)
+// - [*] indicates an assertion (e.g. * Check the title)
+// - Use element testID when selecting an element. Create one if none.
+// *******************************************************************
+
 import {toChannelScreen} from '@support/ui/screen';
 
 import {Setup} from '@support/server_api';
diff --git a/detox/e2e/test/smoke_test/channels.e2e.js b/detox/e2e/test/smoke_test/channels.e2e.js
index 89badfa07..5739faf0c 100644
--- a/detox/e2e/test/smoke_test/channels.e2e.js
+++ b/detox/e2e/test/smoke_test/channels.e2e.js
@@ -1,6 +1,12 @@
 // Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
 // See LICENSE.txt for license information.
 
+// *******************************************************************
+// - [#] indicates a test step (e.g. # Go to a screen)
+// - [*] indicates an assertion (e.g. * Check the title)
+// - Use element testID when selecting an element. Create one if none.
+// *******************************************************************
+
 import {toChannelScreen} from '@support/ui/screen';
 
 import {Setup, Channel} from '@support/server_api';
diff --git a/detox/e2e/test/smoke_test/login_ldap.e2e.js b/detox/e2e/test/smoke_test/login_ldap.e2e.js
index 85a9abd00..04a9e4edc 100644
--- a/detox/e2e/test/smoke_test/login_ldap.e2e.js
+++ b/detox/e2e/test/smoke_test/login_ldap.e2e.js
@@ -1,6 +1,12 @@
 // Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
 // See LICENSE.txt for license information.
 
+// *******************************************************************
+// - [#] indicates a test step (e.g. # Go to a screen)
+// - [*] indicates an assertion (e.g. * Check the title)
+// - Use element testID when selecting an element. Create one if none.
+// *******************************************************************
+
 import {Ldap, Setup, System, Team, User} from '@support/server_api';
 import {serverUrl} from '@support/test_config';
 import ldapUsers from '@support/fixtures/ldap_users.json';