Skip to main content

Committing Changes in a Repository

In this guide, we will cover the process of committing changes to a repository using git. Commits are the heart of version control, enabling you to keep a record of changes made to the project over time.

What is a Commit?​

A commit, or "revision", is an individual change to a file (or set of files). It's like when you save a file, except with git, every time you save it creates a unique ID (a.k.a. the "SHA" or "hash") that allows you to keep record of what changes were made when and by who. Commits usually contain a commit message which is a brief description of what changes were made.

How to Commit Changes​

1. Check the Status of Your Files​

The first step is to check the status of your files. This can be done using the git status command. This command will show you which files have changes that are not yet committed to the repository.

git status

2. Stage Your Changes​

Once you've determined which files you want to commit, you need to "stage" them. Staging is the step before the commit process in git. It's the process of preparing and organizing the changes for the commit.

You can stage files using the git add command followed by the file names.

git add file1.txt file2.txt

If you want to add all your changes, you can use the following command.

git add .

3. Commit Your Changes​

After staging your changes, you can now commit them to the repository. This is done using the git commit command followed by the -m option (for message) and your commit message in quotes.

git commit -m "Your detailed commit message"

This command takes your staged changes and packages them into a commit with a message describing what changes you made.

Commit Best Practices​

  • Make Frequent Commits: This makes it easier to understand what changes were made and why. It also allows you to switch back to a previous version of your project with ease.

  • Write Good Commit Messages: A good commit message is concise yet explains what changes were made and why. This helps other developers (or your future self) understand why these changes were necessary.

  • Test Before You Commit: Always make sure your code works as expected before committing. This will help maintain the quality of your project.

Remember, committing is a crucial part of version control. It allows you to keep track of changes, understand why they were made, and even revert them if necessary. So take the time to commit properly and your future self will thank you.