JIYIK CN >

In our daily lives, it is important to address someone by their first name when interacting with them. After all, their name is most importantly associated with who they are, and it is the easiest way to get someone's attention.

Most importantly, the name must be concise so that others do not feel any problem in calling out or using their name.

The same is true in Git. Naming of Git repositories should be consistent and compatible so that users of your Git account can easily access the repositories they need without any hassle, making it more authentic and professional to use these names for your work.

As someone from the Git repository said: "Great repository names are short and memorable".

Naming conventions for repositories in Git

When using Git, choosing a concise and up-to-date repository name is a difficult task. There are two rules you should follow when naming your repository in Git.

1. Repository names should be unique according to your account.

   This means your repository name should be different from your teammate's. For example, if your repository name is my-best-repo and your teammate also has a repository named my-best-repo.

   This is not possible, because it is not possible to have two repositories with the same name under one account when using Git.

   This means that someone else can have a repository called my-awesome-repo on GitHub, and you can have one too. However, you cannot have two repositories with the same name under your account.

2. Choose a concise and compatible name that reflects your project.

   People name their repositories according to their preferences; some prefer hyphens to separate words, while others use underscores _.

   This is a matter of personal preference. Any character except space and tab can be used as a separator. You should also perform naming conversions based on your team's preferences and rules.

Git repository name examples

Following the advice given above, we will see how our repository should look like. We will split our repo name into three parts separated by hyphens.

section1-section2-section3

1. Part 1 defines the name of the project we work on as a team.
2. Section 2 defines the purpose of the project and the project definition.
3. Section 3 defines the language or framework of the project.

This might look like the following.

Air-SoapAPI-CSharp

If we want to split the above mentioned parts, we can further separate them by hyphens, for example, if we separate Part 2 from the above example Soap-API.

Summarize

In this article, we summarize the standards for repository names in Git, including:

1. Descriptive
2. Ongoing
3. Brief
4. Future-proof
5. Scalable
6. Reusable
7. context
8. Readable