Skip to content

Commit 6e8d52f

Browse files
Not my personal preference but putting Jira in code tags for now
1 parent 549dc15 commit 6e8d52f

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -50,30 +50,28 @@ not work as intended). This can either be done locally or via a pipeline/workflo
5050

5151
When we create new tests, or significantly change the functionality of a test, we should demonstrate these tests work
5252
by [recording the trace using Playwright](https://playwright.dev/python/docs/trace-viewer-intro) and attaching the
53-
<!-- vale off -->
54-
generated trace file to the associated ticket within Jira.
53+
generated trace file to the associated ticket within `Jira`.
5554

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

6462
#### Example
6563

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

7068
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
7169
the behaviour of the test in any way (just makes the elements reusable). In this instance, we should upload the HTML report
72-
<!-- vale off --> to the Jira ticket showing the test passing as the logic of the test has not changed in any way. <!-- vale on -->
70+
to the `Jira` ticket showing the test passing as the logic of the test has not changed in any way.
7371

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

7876
## Coding Practices
7977

0 commit comments

Comments
 (0)