github

GitHub Conventions

• Repository Names
  • Use all lowercase letters.
  • Use hyphenated spaces.
  • Use versionless phrases.
• Branch Names

Repository Names

A lab's GitHub organization hosts many repositories that we use to collaborate. Each repository name should represent the most general possible topic description for that project. Our repository names should:

Use all lowercase letters.

• ✅ my-new-repository
• 🚫 My-New-Repository

Use hyphenated spaces.

• ✅ twitter-survey-client
• 🚫 twitter_survey_client or twitterSurveyClient

Use versionless phrases.

If you find yourself wanting to version your repository name, you probably are interested in releasing tagged versions of the project instead.

• ✅ amplification
• 🚫 amplification-10-02 or amplification-v1

Branch Names

Within a repository, you will have a minimum of one default branch. A default branch should be considered the most stable branch, meaning the least likely to contain bugs, errors, badly-written code, etc. In GitHub, the main branch is the default branch (or master if created prior to late 2020; update the default to main if so, see why here).