Git Commands Documentation

Github Project: Git Commands
Documentation Template
Programming for Data Science Nanodegree Program
You will use this template to copy and paste the git commands you used to complete all
tasks on your local and remote git repository for this project. This file will serve as your
submission for the GitHub project.
Instructions:
1. Make a copy of this Git Commands Documentation template on your Google Drive.
2. Complete the four sections in this document with the appropriate git commands.
3. Download this document as a PDF file.
4. Submit this on the Project Submission page within the Udacity Classroom.
1. Set Up Your Repository
The following are the steps you will take to create your git repository, add your
python code, and post your files on GitHub.
Step 1. Create a GitHub profile (if you don’t already have one).
Step 2. Fork a repository from Udacity’s GitHub Project repository and provide a link to
your forked GitHub repository here:
GitHub Repository Link
https://github.com/Jules000/pdsnd_github
Step 3. Complete the tasks outlined in the table below and copy and paste your git
commands into the “Git Commands” column. The first git command is partially filled out for
you.
Tasks Git Commands
A. Clone the GitHub repository to your local git clone

repository. https://github.com/Jules000/pdsnd_git
hub Explore-US-Bikeshare-Data
B. Move your bikeshare.py and data files into No git command needed (you can
your local repository. use cp or a GUI)
C. Create a .gitignore file containing the name No git command needed (you can
of your data file. use touch or a GUI)
D. List the file names associated with the data No git command needed (add the
files you added to your .gitignore file names into your .gitignore
file)
E. Check the status of your files to make sure git status

your files are not being tracked
F. Stage your changes. git add .

G. Commit your changes with a descriptive git commit -m "Project setting up"
message.
H. Push your commit to your remote repository. git push orijin master
2. Improve Documentation
Now you will be working in your local repository, on the BikeShare python file and
the README.md file. You should repeat steps C through E three times to make at
least three commits as you work on your documentation improvements.
Tasks Git Commands
A. Create a branch named documentation on git branch documentation

your local repository.
B. Switch to the documentation branch. git checkout documentation
C. Update your README.md file. No git command needed (edit the

text in your README.md file)
D. Stage your changes. git add .
E. Commit your work with a descriptive git commit -m “Edition of the

message. readme”
F. Push your commit to your remote repository git push origin documentation
branch.
G. Switch back to the master branch. git checkout master

3. Additional Changes to Documentation
In a real world situation, you or other members of your team would likely be making
other changes to documentation on the documentation branch. To simulate this
follow the tasks below.
Tasks Git Commands
A. Switch to the documentation branch. git checkout documentation
B. Make at least 2 additional changes to the

documentation - this might be additional
changes to the README or changes to the
document strings and line comments of the
bikeshare file.
C. After each change, stage and commit your git commit -m “Code with case
changes. When you commit your work, you sensitivity problem”
should use a descriptive message of the
changes made. Your changes should be
small and aligned with your commit
message.
D. Push your changes to the remote repository git push origin documentation
branch.
E. Switch back to the master branch. git checkout master
F. Check the local repository log to see how all git log --all
the branches have changed.
G. Go to Github. Notice that you now have two No git command needed
branches available for your project, and
when you change branches the README
changes.
4. Refactor Code
Now you will be working in your local repository, on the code in your BikeShare
python file to make improvements to its efficiency and readability. You should
repeat steps C through E three times to make at least three commits as you refactor.
Tasks Git Commands
A. Create a branch named refactoring on your git branch refactoring

local repository.
B. Switch to the refactoring branch. git checkout refactoring
C. Similar to the process you used in making No git command needed (edit the
the documentation changes, make 2 or more code in your python file)
changes in refactoring your code.
D. For each change, stage and commit your work git commit -m "New function:
with a descriptive message of the changes display_data()"
made.
git commit -m "dealing with the
case sensitivity problem"
E. Push your commits to your remote git push origin refactoring

repository branch.
F. Switch back to the master branch. git checkout master
G. Check the local repository log to see how all git log --all
the branches have changed.
H. Go to GitHub. Notice that you now have 3 No git command needed

branches. Notice how the files change as
you move through the branches.
5. Merge Branches
Tasks Git Commands
A. Switch to the master branch. git checkout master
B. Pull the changes you and your coworkers git pull origin master
might have made in the passing days (in this git pull origin documentation
case, you won't have any updates, but pulling git pull origin refactoring
changes is often the first thing you do each
day).
C. Since your changes are all ready to go, merge git merge documentation
all the branches into the master. Address any refactoring
merge conflicts. If you split up your work
among your branches correctly, you should
have no merge conflicts.
D. You should see a message that shows the No git command needed
changes to the files, insertions, and
deletions.
E. Push the repository to your remote git push origin master

repository.
F. Go to GitHub. Notice that your master No git command needed

branch has all of the changes.
Submission:
This concludes the project.
● Please review this document to make sure you entered all the required response
fields in all four sections.
● Download this document as a PDF file.
● Submit the PDF file on the Project Submission page within the Udacity Classroom.

Git Commands Documentation

Uploaded by

Copyright:

Available Formats

Git Commands Documentation

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Git Commands Documentation

Uploaded by

Copyright:

Available Formats

Github Project: Git Commands

3. Download this document as a PDF file.

GitHub Repository Link

Tasks Git Commands

A. Clone the GitHub repository to your local git clone

E. Check the status of your files to make sure git status

F. Stage your changes. git add .

Tasks Git Commands

A. Create a branch named documentation on git branch documentation

B. Switch to the documentation branch. git checkout documentation

C. Update your README.md file. No git command needed (edit the

D. Stage your changes. git add .

E. Commit your work with a descriptive git commit -m “Edition of the

G. Switch back to the master branch. git checkout master

Tasks Git Commands

A. Switch to the documentation branch. git checkout documentation

B. Make at least 2 additional changes to the

E. Switch back to the master branch. git checkout master

Tasks Git Commands

A. Create a branch named refactoring on your git branch refactoring

B. Switch to the refactoring branch. git checkout refactoring

E. Push your commits to your remote git push origin refactoring

F. Switch back to the master branch. git checkout master

H. Go to GitHub. Notice that you now have 3 No git command needed

Tasks Git Commands

A. Switch to the master branch. git checkout master

E. Push the repository to your remote git push origin master

F. Go to GitHub. Notice that your master No git command needed

You might also like