Formatting

A logical naming scheme for code in a GitHub repository should aim to be consistent, descriptive, and organized.

Formatting

1. Prefix

Start each repository name with a prefix or namespace that identifies the team or department that owns or primarily works on the repository. For example:

• team-a-project
• team-b-backend
• marketing-website

2. Use of hyphens

Separate words in repository names with hyphens or underscores for readability. GitHub allows both, but hyphens (-) are more common and preferred in repository names.

3. Descriptive names

Use descriptive names that reflect the purpose or functionality of the repository. This helps team members and others in the organization quickly understand what the repository is for. For example:

• android-app
• customer-database
• devops-scripts

4. Avoid abbreviations unless standardized

Abbreviations can be confusing unless they are well-known within the organization. It's generally better to use full words unless there is a widely accepted abbreviation. For instance:

• web-application is clearer than web-app
• user-interface is clearer than ui

Folders and Files

For an overview of all content see Table of Contents

Structure

• code in .ipynb.
• data in .xlsx and .csv.
• docs
  • Documentation in .md.
  • Slides and schedule in .pdf
  • Images in .png