This repository was created as an exercise in using git and github for PhonLab users. The task is to add a figure to Susan's repository that you would like to discuss at the next Lab meeting.
Create a github account and fork this repository to your account. Clone that repository into the BPM, add your figure, and push the changes to github. Submit a pull request to Susan to add your changes to her repository.
Go to https://github.com and create an account. We'll assume you can handle this on your own. You can use your @berkeley.edu address or a personal email account when you sign up.
The idea in this step is to create a copy of Susan's repository under your own account on github. This will be a public repository, just like the original.
- Visit https://github.com/susanlinucb/figures_160929 in your web browser.
- Click on the 'Fork' button in the upper right corner.
- Your fork will be created, and your web browser will automatically redirect to your forked repository. Take note of the url for the next step.
In this step you will make a copy of your fork on your local system. This repository is private unless you take steps to open it to the world.
- Start the BPM and open a terminal window. Your home directory should be your current working directory.
- Make a clone under the
srcdirectory with these commands:
cd src
git clone https://github.com/[myusername]/figures_160929 # url of your fork
- Now make the repository your working directory:
cd figures_160929
Is there a difference between forking and cloning? Not really, both are complete copies of a repository. The word 'fork' is used on github for server-to-server clones and isn't a term used by git itself.
The next task is to copy your figure to the repository and commit the changes.
- Using the command line or file browser, copy your figure to
~/src/figures_160929. - At the command line, take a look at the changes you have made to the repo:
git status
- You should see the name of the file you just added in the 'Untracked files' section of the status message.
- Tell
gitto start tracking the file by adding it to the repository, then check the status again:
git add yourfile.png
git status
- Your file should now be in the 'Changes to be committed' section. Commit the change to the repository, including a short message describing the change:
git commit -m "Added ...'s figure file."
- Check the status again, which should tell you that you are ahead of 'origin/master' by 1 commit:
git status
At this point your changes have been committed to your local, private repository only and no one else can see them. Note that in git terminology each repository copy is a repository in its own right, and the use of 'commit' is subtly different than in other version control systems that are not as distributed in character. When you 'commit' in git you make your changes in a repository permanent, and this repository is often (but not always) your local one. These changes do not automatically propagate to other related repositories. In other version control systems (like svn), a 'commit' makes your changes permanent and simultaneously copies them to the master repository.
In order to make your committed changes public you must push them to your public repository on github:
git push
-
You may be asked to enter your github username and password. When typing in your password, the terminal window will not show any characters.
-
If everything is already up-to-date, you will get a message saying as much.
-
Check the status:
git status
- The status message should include: "Your branch is up-to-date with 'origin/master'."
- Visit your public repository at https://github.com/[myusername]/figures_160929. You should see the figure you added is now in your public repository.
If the git push command returns a 403 error, it could mean you accidentally cloned from susanlinucb rather than your own public repository.
The final step is to submit a request to Susan to pull the changes in your public repository into her public repository.
- From your public repository on github, click the 'New pull request' button.
- The 'Comparing changes' page will probably indicate that the repositories are 'Able to merge', unless you happened to give your figure the same name as one that has already been added to Susan's public repository. Click on the 'Create pull request' button.
- On the 'Open a pull request page', leave a short comment describing what's in your pull request, then click the 'Create pull request' button.
Once you have completed these steps it will be Susan's responsibility to review and merge your changes into her repository.
Did you find a typo while you read these instructions? Are they confusing, incomplete, or downright wrong in spots? If so, make a correction to this file and submit a pull request so that others will not be misled. Thanks!