GitHub Community
GitHub Repository Name vs Description vs README Heading H1 #23793
-
|
I am looking for a guide or a naming convention documentation that explains best practices for your GitHub Repository Name vs the Description Field vs the H1 Heading of the README. I am working on a Naming Convention Guide for my company and the situation I want to use in the guide is where the Repository Name will have 1 name that is short and separated by dashes “-” The Description will be a longer more descriptive version of the Repository Name, and the Heading H1 will usually be somewhere in between in terms of Length of title. I am looking for documentation that explains the relationship between the 3 GitHub sections and how to go about naming each section. |
Beta Was this translation helpful? Give feedback.
Replies: 1 comment
-
|
Hi @jpkmw! 👋 There isn’t really one true naming convention - different people come up with different conventions to suit themselves. Having a short repository name that is alphanumeric strings separated by dashes One thing to consider with the description field is that it can be searched: …so you might want to put key words in there! And then the H1 of the README is going to be the prominent title that people see when they land on the repo. It doesn’t necessarily need to repeat the repository name. It could be a call to action, a title to establish context, or anything else you think might be useful. |
Beta Was this translation helpful? Give feedback.
Hi @jpkmw! 👋
There isn’t really one true naming convention - different people come up with different conventions to suit themselves.
Having a short repository name that is alphanumeric strings separated by dashes
-makes sense! You could also potentially use periods.. Dashes and periods are the only punctuation marks allowed in repo names.One thing to consider with the description field is that it can be searched:
https://help.github.com/en/github/searching-for-information-on-github/searching-for-repositories#search-by-repository-name-description-or-contents-of-the-readme-file
…so you might want to put key words in there!
And then the H1 of the README is going to be the prominent title …