docs: Fix test instructions and generally spruce up the README. #3952
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The example doesn't work without running the build steps first, which aren't mentioned anywhere else in the doc.
andysellick
reviewed
Mar 25, 2024
Tech writing style fixes: - avoid unnecessary use of the passive voice - prefer imperative over present continuous in headings - use a separate paragraph for the point about accessibility standards Remove confusing information about GOV.UK Docker. Docker isn't necessary for development work on this gem.
|
Ready for another look :) |
andysellick
approved these changes
Mar 26, 2024
| yarn run jasmine:browser | ||
| ``` |
There was a problem hiding this comment.
Just realised this doesn't state that the tests can be seen in a browser at http://localhost:8888 - do you think it's worth adding? (non-blocking)
There was a problem hiding this comment.
Also worth noting that the test server needs a restart to pick up any changes to the JavaScript - again potentially out of scope, might be better to link to another page to go more in depth. Happy to raise a separate PR if you think it's useful.
There was a problem hiding this comment.
Ah cool, thanks! I'll add.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The 'Run the test suite' instructions didn't work without a couple of build steps which weren't mentioned anywhere in the README. Add them to the example so that it works for new contributors.
Also remove some confusing information about GOV.UK Docker and generally tidy up the README to bring it in line with GDS tech writing style.
No changes to the gem itself apart from the README.