semgit / semgit-spec-repository-naming

Semantic naming specification for Git repositories
11 stars 0 forks source link

semgit delimiters #1

Open ElliotPsyIT opened 9 years ago

ElliotPsyIT commented 9 years ago

Glad to see some careful thought put into a style guide for git repo naming. A very good effort here!

In this spec currently, a hyphen delimits each of the three (semantic) sections. With a single word in each section, reading a semgit name left to right easily reveals the repo's intent. As in a few of the examples listed:

# Go applications
semgit-go-private-api
semgit-go-public-api

# Node applications
semgit-node-deployment-cli
semgit-node-web-server

# Websites
semgit-web-ghost-developer-blog
semgit-web-corporate-website
semgit-web-jekyll-blog

# WinRT application
semgit-winrt-client-application

As the ending 'description' section grows, however, reading left to right might take a bit more mental parsing. I was wondering if a different delimiter for the third section might make mental parsing a bit more efficient. Perhaps a double hyphen, as in:

# Websites
semgit-web--ghost-developer-blog
semgit-web--corporate-website
semgit-web--jekyll-blog

# WinRT application
semgit-winrt--client-application

etc...