Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Standardise how words are being emphasised in the describe() or it() blocks of a unit test #120

Closed
Jozzey opened this issue May 23, 2024 · 1 comment
Assignees
Labels
housekeeping Refactoring, tidying up or other work which supports the project

Comments

@Jozzey
Copy link
Contributor

Jozzey commented May 23, 2024

There has been some inconsistency in how words are being emphasised in the describe() or it() blocks of a unit test.

Following a discussion on our daily dev call we agreed on a standard where the descriptive text would always be wrapped in single quotes. This has been added to our coding convention here https://github.com/DEFRA/water-abstraction-team/blob/main/coding_conventions.md#unit-test-descriptive-text. If there is a word(s) within that text that we want to emphasise then this would be wrapped in double quotes.

This issue deals with fixing this inconsistency in the https://github.com/DEFRA/water-abstraction-system repo.

@Jozzey Jozzey added the housekeeping Refactoring, tidying up or other work which supports the project label May 23, 2024
@Jozzey Jozzey self-assigned this May 23, 2024
Jozzey added a commit to DEFRA/water-abstraction-system that referenced this issue May 30, 2024
@Jozzey
Copy link
Contributor Author

Jozzey commented May 31, 2024

@Jozzey Jozzey closed this as completed May 31, 2024
Jozzey added a commit to DEFRA/water-abstraction-system that referenced this issue May 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
housekeeping Refactoring, tidying up or other work which supports the project
Projects
None yet
Development

No branches or pull requests

1 participant