Creating a Repository on GitHub for Beginners

What is a GitHub Repository

A GitHub repository is a space for managing all files and change history of a software project. It includes source code, documentation, configuration files, issues, and pull requests. Public repositories are accessible to everyone, while private ones are restricted to specified users. GitHub is based on the Git version control system, allowing repositories to be stored both locally and in the cloud.

Key features of GitHub repositories include:

• Version control: Tracks file changes and allows reverting to previous states.
• Collaboration: Multiple developers can work simultaneously and conduct code reviews through pull requests.
• Issue tracker: Manages bugs, feature requests, and task schedules.
• GitHub Actions: Sets up automated build, test, and deployment workflows.

Requirements and Prerequisites

Before creating a GitHub repository, prepare the following:

• GitHub account: Visit github.com to sign up and log in.
• Git installation: Install Git from git-scm.com to use Git commands locally. Git installation is not required if using GitHub Desktop.
• Internet connection: An internet connection is necessary for repository creation and synchronization.

GitHub accounts are available in free and paid plans. The free plan offers up to 1,000 minutes of GitHub Actions usage per month for both public and private repositories. Paid plans provide access to more resources.

Creating a Repository: Using the Web Interface

To create a GitHub repository using the web interface, follow these steps:

1. Log in to GitHub.

2. Click the ‘+’ button in the upper right corner and select ‘New repository’.

3. On the repository creation screen, enter the following:

   • Repository name: Use lowercase letters, numbers, hyphens (-), and underscores (_). Example: my-first-repo
   • Description: Write a description of the repository (optional).
   • Public/Private: Set the repository to public or private.
   • Initialize this repository with a README: Check this box to automatically create a README file.
   • Add .gitignore: Add a .gitignore file to ignore specific files or directories (optional).
   • Choose a license: Select a license for the project (optional).

4. Click ‘Create repository’.

5. Once the repository is created, you will be directed to the repository page. If a README file was included, the README.md file will be displayed.

Creating a Repository: Using GitHub Desktop

GitHub Desktop provides a graphical interface for creating and managing repositories without needing to know Git commands. To create a repository using GitHub Desktop, follow these steps:

1. Download the installation file for your operating system from the GitHub Desktop download page.

2. Run the installation file to install GitHub Desktop.

3. Launch GitHub Desktop and log in with your GitHub account.

4. Select ‘New Repository’ from the ‘File’ menu.

5. In the repository creation window, enter the following:

   • Name: Enter the repository name. Example: my-first-repo-desktop
   • Description: Write a description of the repository (optional).
   • Local path: Choose the local path to save the repository.
   • Visibility: Set to public or private.
   • Initialize repository with README: Check this box to automatically create a README file.

6. Click ‘Create Repository’.

7. The repository will be created, and a local folder will be generated. The status of the repository can be checked in the ‘Repository’ tab of GitHub Desktop.

Connecting Local Repository to GitHub Repository

To connect a project worked on locally to a GitHub repository, follow these steps. This can be done using Git commands or GitHub Desktop.

Connecting Using Git Commands

1. Navigate to the local project folder.

2. In the terminal or command prompt, run the following command to initialize the Git repository:

   git init
   

3. Copy the remote repository URL. Click the ‘Code’ button on the GitHub repository page, select ‘HTTPS’ or ‘SSH’, and copy the URL.

4. Connect the local repository to the remote repository:

   git remote add origin [remote repository URL]
   

   Example: git remote add origin https://github.com/username/my-first-repo.git

5. Commit local changes:

   git add .
   git commit -m "Initial commit"
   

6. Push changes to the remote repository:

   git push -u origin main
   

Connecting Using GitHub Desktop

1. In GitHub Desktop, select ‘Clone Repository’ from the ‘File’ menu.

2. In the ‘URL’ tab, enter the remote repository URL or select ‘GitHub.com’ to choose the repository.

3. Select the local path and click ‘Clone’.

4. In the ‘Changes’ tab of GitHub Desktop, review changes and write a commit message.

5. Click ‘Commit to main’ and then click ‘Push origin’ to push changes to the remote repository.

Managing the Repository and Basic Workflow

After creating a repository, follow this basic workflow to manage the project.

1. Modify code locally:

   • Edit files or add new files in the local folder.

2. Commit changes:

   • In GitHub Desktop, review modified files in the ‘Changes’ tab and write a commit message.
   • If using Git commands, run git add . and git commit -m "message".

3. Push to the remote repository:

   • Click ‘Push origin’ in GitHub Desktop.
   • If using Git commands, run git push.

4. Create a pull request (during collaboration):

   • Click the ‘Pull requests’ tab on the GitHub repository page.
   • Click ‘New pull request’ and select branches to compare.
   • Describe changes and assign reviewers.

5. Code review and merge:

   • Reviewers conduct code reviews.
   • Once completed, click ‘Merge pull request’ to merge changes into the main branch.

Frequently Asked Questions

Must GitHub repository names use only English?

No. Repository names can include lowercase letters, numbers, hyphens (-), and underscores (_). Korean characters or spaces are not allowed. Repository names cannot be changed later, so choose carefully.

Is it necessary to create a README file?

A README file is not required to create a repository. However, including a README file can document project descriptions, installation instructions, and usage, which is useful for collaboration. GitHub offers an option to automatically create a README file when generating a repository.

Can a GitHub repository be set to private?

Yes. Private repositories can be created even on the free plan. Only specified users can access private repositories, while public repositories are visible to everyone. Private repositories can be used for free without switching to a paid plan.