GitHub Repository Naming Convention (English version)

Objective:

Define a clear and consistent method for naming GitHub repositories in order to improve project understanding, discoverability, and maintainability within an organization.

General Principle

The naming convention should follow a standardized structure that allows quick identification of:

• the project type

• the main function

• the domain or project context

Recommended format:

project-type-function

Examples:

• api-authentication
• web-dashboard
• service-payment
• library-data-parser
• cli-backup-tool

Naming Rules

The following rules should be respected:

• Use only lowercase letters

• Use hyphens (-) to separate words

• Avoid spaces, uppercase letters, and special characters

• Choose names that are short but descriptive

• Avoid ambiguous abbreviations

Maintain consistency across all repositories in the organization

Recommended Structure

• Project type

• Indicates the technical nature of the repository.

Examples:

• api
• web
• service
• library
• cli
• infra
• docs

Main function or role

Describes the main purpose of the project.

Examples:

• authentication
• payment
• notifications
• analytics
• monitoring
• storage

Domain or context (optional)

Specifies the business domain or usage context.

Examples:

• finance
• health
• education
• internal
• public

Example of a Complete Naming Convention

• api-authentication
• service-payment-finance
• web-admin-dashboard
• library-data-parser
• cli-database-backup
• infra-kubernetes-config

This structure enables:

• quick repository identification

• better project organization

• easier GitHub searchability

• organization-wide standardization