4.1 Repository Creation

The Policy

4.1 Repository Creation: Repository names should be clear, descriptive, and adhere to naming conventions of (use hyphens or underscores for readability. Avoid special characters, spaces, or uppercase letters in repository names).

Implementation

Some examples of good names:

https://github.com/ONSdigital/address-index-api
To the point it is the address index api and there can be no confusion

https://github.com/ONSdigital/ons-prices-terraform
Having the the organisation included is a good pattern to follow, the work is prices and code is Terraform Brilliant!

https://github.com/ONSdigital/takeon-ui
It's the takeon UI brilliant!

Some examples of names that could be improved:

https://github.com/ONSdigital/sa-connection-audit
SA can have many meanings, connection to what? Auditing what? It is not clear what the function of the repo does

https://github.com/ONSdigital/sbr3-openapi-specs
SBR3 is not a common abbrevation a more user friendly name would help. 😿

https://github.com/ONSdigital/homebrew-dp-cli
I know what homebrew is, I know what a CLI is, DP? Maybe Digital Publishing. The name doesn't convey what the repo may be doing