Skip to content

Instantly share code, notes, and snippets.

@patrickblackjr

patrickblackjr/repo naming standards.md

Created September 1, 2022 13:34
Show Gist options
  • Save patrickblackjr/a49f3a393359edbd5c1d4e143423ddf5 to your computer and use it in GitHub Desktop.
Save patrickblackjr/a49f3a393359edbd5c1d4e143423ddf5 to your computer and use it in GitHub Desktop.
Download ZIP
GitHub Naming Standards
Raw
repo naming standards.md

Introduction

A naming strategy for GitHub repositories helps identify the repository at a glance. The naming standard has been designed to easily visualize the purpose and description of the repository.

Each GitHub repository name should meet the following criteria:

  • Descriptive

  • Readable

  • Consistent

  • Contextual

  • Brief (short / succinct)

  • Use Lower Case

  • Use Dashes

Requirements and Recommendations

DO

  • Use lowercase
  • Use dashes to separate prefixes
  • Mention the abbreviation for project name
  • Mention the abbreviation for repository type
  • Mention the abbreviation for deployment platform
  • Avoid duplication

DO NOT

  • Use uppercase
  • Use CamelCase
  • Use special characters
  • Use sensitive information
  • Use credentials (usernames, service accounts, etc)
  • Use spaces

Examples

customer-project-type-[location]

  • customer-deploy-infra-gcp
  • internal-deeznuts-webapp-onprem
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment