DaleSchool

Creating Your First Repository

Beginner15min

Learning Objectives

  • Create a new repository on GitHub
  • Write a README.md to introduce your project
  • Understand the main sections of a repository page

Creating a Repository

Log in to GitHub and create a repository.

  1. Click the + button in the top-right corner → New repository
  2. Fill in the settings:
FieldValueDescription
Repository namemy-first-repoThe repo name (included in the URL)
DescriptionMy first GitHub repositoryOptional, a short introduction
Public / PrivatePublicAnyone can see it
Add a README fileCheckAuto-generates an initial file
  1. Click Create repository

Once created, you can access it at github.com/yourusername/my-first-repo.

Exploring the Repository Page

Here are the main tabs on a repository page.

TabPurpose
CodeFile list and contents. The default view.
IssuesBug reports, feature requests, task management
Pull requestsReview and merge change requests
ActionsAutomated workflows (CI/CD)
SettingsRepo name, permissions, deletion, etc.

Editing README.md

The README is the first document visitors see when they open your repository. It is your project's first impression.

  1. Click the README.md file
  2. Click the pencil icon (Edit this file)
  3. Edit the content:
# My First GitHub Repository

A practice repository created while taking the GitHub intro course.

## What I Learned

- Creating a GitHub repository
- Writing a README
- Committing files
  1. Click Commit changes in the top-right
  2. Enter a commit message: docs: update README
  3. Click the Commit changes button to save

"Why?" — Why the README Matters

The README tells first-time visitors:

  • What is this project?
  • How do you use it?
  • How can you contribute?

The quality of an open-source project is often judged by its README. A good README attracts collaborators; a bad one drives people away.

What is Markdown?

READMEs are written in Markdown format. # creates headings, **bold** makes text bold, and - creates lists. Simple syntax for clean documents.

# Heading 1

## Heading 2

**bold** _italic_

- List item 1
- List item 2

[Link text](https://example.com)

Deep Dive

Public vs Private Repositories

Public: Anyone in the world can view the code. Ideal for open-source projects. Free.

Private: Only invited people can see it. Ideal for company projects or personal work. Free accounts can create unlimited private repos (with collaborator limits).

Starting with Public is fine when you are learning. You can switch in Settings at any time.

Repository Naming Rules
  • Letters, numbers, hyphens (-), and underscores (_) are allowed
  • Spaces are automatically converted to hyphens
  • Case-insensitive (lowercase recommended for URLs)
  • Duplicate names under the same account are not allowed

Good name examples: my-portfolio, study-notes, daleschool-projects

  1. Create a my-first-repo repository on GitHub (Public, with a README).
  2. Edit the README.md with your own introduction and commit it.
  3. Verify the repository URL (github.com/username/my-first-repo).

What best describes the role of a README.md file?

Further Reading