Skip to main content

Naming Conventions:

Naming conventions are important for:

  1. Onboarding
  2. Understanding
  3. Dependancies

Conventions should aim to be:

  1. As short as possible
  2. Not containing duplicates
  3. Agreed between teams

The Bad:​

Here are some examples we have found that are not great...

If the Gitlab Path does not equal to the actual remote path. For example:

Multiple occurances of names (we know it's rapha): https://gitlab.com/rapharacing/rapha-middleware/rapha-customer-node

Inconsistency:​

Project Title: Minas Tirith Gitlab Project URL: https://gitlab.com/rapharacing/rapha-middleware/gateway-waf

Other:​

Gitlab: Names with Capitals in Gitlab should be avoided (gitlab projects/repos are always lowercase)

Project Names with special characters should be avoided

In Gitlab: Repository names MUST match remote URL

Gitlab Naming Requirements​

In Gitlab specifically create:

  1. A brief description for the project that states what it does
  2. A name that doesn’t repeat the group name
  3. A populated README.md that discusses what the project is doing and any relevant architectural diagrams
  4. A contributing.md to share how to easily contribute