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.
Updating the README based on giving this a whirl. The output is really nice.
NB. one line has been removed here because it was unclear the intention so it might need adding in another commit:
The last link is a 404 and so needs to be corrected either way.
Pre-commit tooling
We have some tooling that should be shared across repositories for consistent formatting of things like Markdown. This means we all contribute following the same foundation making it easier and reducing cognitive load. Probably especially important for public contributions so that they follow a consistent standard.
Each commit is atomic, two specifically of interest when reviewing:
Adding the tooling: 4b3d3e7
Formatting the README: a127aba
There is a .github workflow that will be triggered for pull-requests as well so that helps catch issues coming in.
Prettier
For markdown, prettier is an option, the glossary is a good reference point:
We have one recipe for it, but I couldn't make it work with this repository. I think maybe because prettier is already used somewhere?
I am not sure if you want to take this one and add it? It can always be added in future.