Collaborating on a GitHub Project- A Complete Guide
Uploaded by
nafees zamanCollaborating on a GitHub Project- A Complete Guide
Uploaded by
nafees zamanCollaborating on a GitHub
Project: A Complete Guide
Table of Contents
1. Introduction
2. Creating a Repository
3. Inviting Collaborators
4. Forking and Cloning a Repository
5. Creating a Branch
6. Making Changes and Committing
7. Pushing Changes to GitHub
8. Creating a Pull Request
9. Reviewing and Merging Pull Requests
10. Syncing Your Fork
11. Resolving Merge Conflicts
12. Conclusion
1. Introduction
GitHub is a powerful platform for version control and collaboration. This guide
provides a step-by-step process on how to effectively collaborate on a project
using GitHub.
2. Creating a Repository
1. Go to GitHub and log in.
2. Click the "+" sign in the top-right corner and select "New repository".
Collaborating on a GitHub Project: A Complete Guide 1
3. Provide a repository name (e.g., my-project ).
4. Add an optional description and choose public or private visibility.
5. Initialize the repository with a README file (optional but recommended).
6. Click "Create repository".
3. Inviting Collaborators
If you own the repository and want to collaborate:
1. Open your repository on GitHub.
2. Click "Settings" > "Collaborators".
3. Click "Add people" and enter their GitHub username.
4. Click "Add" to send an invitation.
4. Forking and Cloning a Repository
If you don’t have direct access to a repository, you can fork it:
1. Open the repository on GitHub.
2. Click the "Fork" button (top-right corner).
3. GitHub creates a copy under your account.
To clone the forked repository:
git clone <https://github.com/your-username/repository-name.
git>
cd repository-name
5. Creating a Branch
To avoid making changes directly to the main branch, create a new branch:
git checkout -b new-feature
Collaborating on a GitHub Project: A Complete Guide 2
Example:
git checkout -b add-login-form
6. Making Changes and Committing
1. Edit your files as needed.
2. Stage the changes:
git add .
1. Commit the changes with a message:
git commit -m "Added login feature"
7. Pushing Changes to GitHub
Push your changes to GitHub:
git push origin new-feature
Example:
git push origin add-login-form
8. Creating a Pull Request
1. Go to the original repository on GitHub.
2. Click "Compare & pull request".
3. Add a title and description for your changes.
4. Click "Create pull request".
Collaborating on a GitHub Project: A Complete Guide 3
9. Reviewing and Merging Pull Requests
1. The repository owner or team members review the pull request.
2. They may request changes or approve it.
3. If approved, click "Merge pull request" > "Confirm merge".
10. Syncing Your Fork
To keep your fork updated with the original repository:
git remote add upstream <https://github.com/original-owner/r
epository-name.git>
git fetch upstream
git checkout main
git merge upstream/main
git push origin main
11. Resolving Merge Conflicts
1. If there are merge conflicts, open the conflicting file.
2. Look for conflict markers ( <<<<<<< , ======= , >>>>>>> ).
3. Manually edit the file to keep necessary changes.
4. Stage and commit the resolved file:
git add .
git commit -m "Resolved merge conflict"
12. Conclusion
By following this guide, you can collaborate effectively on GitHub while
maintaining a structured workflow. Whether you are working with a team or
contributing to an open-source project, these steps will help streamline the
process.
Collaborating on a GitHub Project: A Complete Guide 4
Collaborating on a GitHub Project: A Complete Guide 5
