Skip to content

Commit b61d154

Browse files
more vale fixes hopefully
1 parent 1f63a3c commit b61d154

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,20 +52,24 @@ When we create new tests, or significantly change the functionality of a test, w
5252
by [recording the trace using Playwright](https://playwright.dev/python/docs/trace-viewer-intro) and attaching the
5353
<!-- vale off -->
5454
generated trace file to the associated ticket within Jira.
55-
<!-- vale on -->
5655

57-
> NOTE: If the trace file exceeds the maximum file attachment size for <!-- vale off -->Jira<!-- vale on -->, we should
56+
> NOTE: If the trace file exceeds the maximum file attachment size for Jira, we should
5857
> upload the file to a Confluence page instead and link this back to the ticket.
58+
<!-- vale on -->
5959
6060
When we modify existing tests (including any page objects or utilities used by these tests) but the behaviour of the test
6161
has not fundamentally changed, we should upload the generated HTML report from the Playwright execution to the
62-
<!-- vale off -->Jira<!-- vale on --> ticket.
62+
<!-- vale off -->
63+
Jira ticket.
64+
<!-- vale on -->
6365

6466
#### Example
6567

6668
We introduce a new test that covers the send a kit functionality for a single subject using `codegen` in the first instance.
6769
To demonstrate this test has worked as intended, we should turn tracing on and generate a trace file from Playwright and
68-
attach this to the ticket in <!-- vale off -->Jira<!-- vale on -->.
70+
<!-- vale off -->
71+
attach this to the ticket in Jira.
72+
<!-- vale on -->
6973

7074
We then decide to refactor the test so that it uses a page object model for the send a kit page, but this does not change
7175
the behaviour of the test in any way (just makes the elements reusable). In this instance, we should upload the HTML report
@@ -75,7 +79,9 @@ to the Jira ticket showing the test passing as the logic of the test has not cha
7579

7680
We then decide to create a utility that loops through several subjects at once and apply this to the previously created send
7781
a kit test. In this instance, we should turn tracing on again and generate a trace file from Playwright and attach this to the
78-
ticket in <!-- vale off -->Jira<!-- vale on -->, because the logic of the test has fundamentally changed.
82+
<!-- vale off -->
83+
ticket in Jira, because the logic of the test has fundamentally changed.
84+
<!-- vale on -->
7985

8086
## Coding Practices
8187

0 commit comments

Comments
 (0)