GitHub Workflow

A classic workflow for using GitHub to clone a repository, make changes, create a new branch, request a pull request, and finally merge the changes into the main branch:
  1. Clone the Repository:

    • Open your terminal or command prompt.
    • Navigate to the directory where you want to clone the repository.
    • Run the command: git clone <repository_url> (replace <repository_url> with the actual URL of the repository).
    • This will create a local copy of the repository on your machine.
  2. Create a New Branch:

    • Change into the repository directory using cd <repository_name>.
    • Create a new branch using the command: git checkout -b <new_branch_name> (replace <new_branch_name> with your desired branch name).
    • This new branch will be used to make and isolate your changes.
  3. Make Changes:

    • Open the project files in your preferred code editor.
    • Make the desired changes to the code, documentation, or any other relevant files.
  4. Stage and Commit Changes:

    • In your terminal, use git status to see the list of changes you’ve made.
    • Use git add <file_name> to stage the changes you want to commit (replace <file_name> with the actual file name or use . to stage all changes).
    • Commit the staged changes with a descriptive message: git commit -m "Your commit message here".
  5. Push Changes to GitHub:

    • Push your local branch to the remote repository on GitHub: git push origin <new_branch_name>.
  6. Create a Pull Request:

    • Go to the GitHub repository in your web browser.
    • You’ll likely see a banner suggesting that you create a pull request for your recently pushed branch. If not, navigate to the “Pull Requests” tab and click on the “New Pull Request” button.
    • Select the base branch (usually “main” or “master”) and compare it with your newly pushed branch.
    • Review the changes and provide a descriptive title and comment for your pull request.
  7. Review and Discussion:

    • Others can review your pull request, ask questions, and suggest changes through comments.
    • You can make further commits to the same branch in response to the feedback.
  8. Merge the Pull Request:

    • After addressing any feedback and when the pull request is ready to be merged, click the “Merge Pull Request” button.
    • You might need to resolve any merge conflicts if there are conflicting changes between your branch and the base branch.
    • Once conflicts are resolved and all checks pass, confirm the merge.
  9. Delete the Branch (Optional):

    • After merging, you can choose to delete the branch you created for the pull request.
    • This keeps your repository clean and organized.
  10. Pull the Latest Changes (Optional):

    • After merging, it’s a good practice to update your local main branch with the latest changes from the remote repository.
    • Switch to the main branch: git checkout main.
    • Pull the latest changes: git pull origin main.

That’s it! You’ve successfully walked through the process of cloning a repository, making changes, creating a new branch, requesting a pull request, and merging the changes into the main branch using GitHub. This workflow promotes collaboration, version control, and proper code management.

Last modified July 21, 2024: update (e2ae86c)