0008 - Naming Repositories, Services, and URLs

Date

2022-11-24

Status

Accepted

Context

It can be hard, at a glance, to get a sense of what a repository or service does, and where it is or should be used. We want to formalise a way of naming repositories to make this clearer. Also, we need to provide this guidance in a way that allows everyone to apply consistently.

There are different relevant contexts/categories that apply to naming, across business verticals, the type of vehicle, how it's accessed, and what it does.

Decision

We will use the following defininitions and conventions as detailed in Naming Repositories, Services, and URLs (https://app.clickup.com/6917829/docs/6k3p5-20387/6k3p5-38376)

Consequences

Naming will become more consistent. Everyone will have to keep this in mind if creating services. This guidelines should get us pretty close to a good result, but concensus should still be sought before commiting. Also, it may be the case that an existing service should house new functionality, since we prefer meso services, rather than micro services. In this case, the existing service should be renamed to reflect the new functionality, if needed.