GitHub Flow - Part 2

2023-09-13
By: O. Wolfson

GitHub Flow - Part 2

Introduction

In our last session, we set up our workspace by forking and cloning the First Contributions repository and configured the upstream remote to stay synchronized with the original project. As we continue our GitHub Flow journey, we will focus on creating a new branch and effectively working on your feature.

Creating a New Branch

Understanding Branches

Branches are integral in GitHub Flow. Creating a branch means duplicating the project at its current state to work independently without affecting the main branch. The main branch should always reflect a deployable state of your project.

How to Create a New Branch

Creating a new branch is simple. Navigate to your project’s directory and run the following command, replacing feature-name with a descriptive name for your branch:

bash
git checkout -b feature-name

Naming Conventions for Branches

Naming your branch appropriately can convey its purpose clearly. Here are some tips for naming your branches:

  • Use hyphens to separate words.
  • Be succinct and descriptive.
  • Prefix the branch name with categories like feature/, fix/, or chore/ to indicate the kind of work involved.

Working on Your Feature

Making Changes Locally

Open the project in your favorite text editor and start making changes. Use the git status command regularly to keep track of the modified files.

Best Practices for Committing Your Changes

Before you commit your changes, adhere to the following practices:

  • Craft clear and descriptive commit messages.
  • Make atomic commits, which refer to small, self-contained changes.
  • Ensure to test your changes locally to confirm everything works as expected.

Commit your changes with this command:

bash
git commit -m "Your descriptive commit message here"

Pushing Changes to Your GitHub Repository

After committing your changes locally, push them to your GitHub repository with this command:

bash
git push origin feature-name

Conclusion

Great job! You've now successfully created a new branch and worked on your feature using GitHub Flow. In our next article, we will cover how to open a pull request and collaborate with other developers to merge your changes into the main branch. Stay tuned and happy coding!