Skip to content

Conversation

@StevenMaude
Copy link

This is a series of small editorial and formatting improvements.

There are also some small URL fixes. Most of these are simply updating HTTP to HTTPS, but there was one broken link.1

Footnotes

  1. These were detected by running lychee against the repository. I've done similar before for OpenSAFELY's documentation; it's useful to add tooling like this to catch broken links, when you're including many URLs in text. NHS Digital's Software Engineering Quality Framework repository uses a similar type of tool.

In general, linking to a branch, and not a specific commit ID is
fragile. But this is probably OK here as we wouldn't expect the
`CONTRIBUTING.md` to be frequently moved.
Presumably this was used as a separator for the appendix.

Visually, this gives a similar effect, but semantically has a different
meaning.
To reduce its size.
@StevenMaude
Copy link
Author

StevenMaude commented Sep 9, 2022

Issues I also spotted, but won't address as not entirely sure of the correct resolution:

  • The "Data Saves Lives" links possibly could be updated to the published version.
  • There's a mixture of types of apostrophe in the documents: ' versus , for example. I don't know what your preferred house style is. Ideally, there should be just one kind in use.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant