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

Identifiers for MHCLG owned registers #304

Open
colmjude opened this issue Jul 13, 2020 · 1 comment
Open

Identifiers for MHCLG owned registers #304

colmjude opened this issue Jul 13, 2020 · 1 comment

Comments

@colmjude
Copy link
Contributor

How should we decide on the identifiers to use in registers owned by MHCLG?

An entry in one of these registers usually has a Name field and a field intended to be the id, which we derive from the name. But there are numerous ways to do it.

  • kebab type the name e.g. Local Plan to local-plan
  • shorten to initial codes e.g. Local Plan to lp or LP
  • use a random UUID
  • ?

We don't have an overwhelming preference but we do favour an approach like the first couple of ways that maintains some semantic value.

For now, we have opted for the kebab approach because it has become our house style and we are trying to maintain consistency.

@colmjude
Copy link
Contributor Author

A potential issue with the approach we take is if the Name field is long. E.g. conservation and enhancement of the natural environment is a field in the development policy category register.

Should we kebab it to conservation-and-enhancement-of-the-natural-environment or shorten it to something more succinct such as conservation-natural-environment?

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

No branches or pull requests

1 participant