This project is to introduce you to practice contributing to a project as a collaborator. You will make a fork of the repository, make changes and propose those changes back to the upstream repository.
-
Fork this repository. Fork this repository by clicking the fork button found at the top of this page. A fork is a new repository that shares code and visibility settings with the orginial upstream repository.
-
Clone the repository. Clone the forked repository to your local machine using
git clonecommand
git clone git@github.com:your/github/repository- Create a branch.
We make a git branch to make a separate version of the main repository. This allows us to make changes while avoiding impact to the live version.
cd to your repository directory and create a branch using the
git branch
git branch username-colabTo check which branches are in the project use git branch and the branch with the * beside it is the branch that we are currently on. To move into the new brach we use the git checkout <branchname> command. Additionally if you want to ccreate the branch and switch to it, you can simplify and use the git switch -c <branchname> command where the -c flag creates a new branch.
git checkout username-collab-
Make your changes and commit them. Open the
Collaborators.mdfile in a text editor. Add your name to the file as well as your favorite restaurant. Save the file. You can use thegit statuscommand to see what files have changed. -
Normally here is where you would run whatever test you want on your branch. This is to ensure that your code works properly and does not alter your main branch. You can push your code to your repository under this branch using
git push --set-upstream origin username-collab. However, once you are satisfied, you can merge your branch into main.
git pull origin main
git checkout main
git merge username-collab- To commit the changes to your main branch. First add the changes to just made use
git add <filename>and commit the changes using `git commit -m "" command.
git add Collaborators.md
git commit -m "<yourname> added to collaborators"- Push changes to GitHub.
To push your changes to GitHub, use the
git pushcommand.
git push- Submit a pull request.
Once you push your changes, submit your changes for review by submitting a
Compare & pull request. On my end, I will merge your changes into the main branch of this project.
Congratulations! You just contributed to a project.
There are additional git commands that are good to know and be familiar with
git statusprovides you with information on the state of the working directory and staging areagit pullis used to sync the remote contentgit pushis used to upload content that have been stage to the remote repositorygit branchto see which branch you are working in