Scribd
Upload
3 views

git

This document provides a template for documenting git commands used in a GitHub project for the Programming for Data Science Nanodegree Program. It outlines steps to set up a repository, improve documentation, refactor code, and merge branches, along with specific tasks and corresponding git commands. The final submission requires downloading the document as a PDF and submitting it on the Udacity Classroom Project Submission page.

Uploaded by

abodawad1111
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
3 views

git

This document provides a template for documenting git commands used in a GitHub project for the Programming for Data Science Nanodegree Program. It outlines steps to set up a repository, improve documentation, refactor code, and merge branches, along with specific tasks and corresponding git commands. The final submission requires downloading the document as a PDF and submitting it on the Udacity Classroom Project Submission page.

Uploaded by

abodawad1111
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 6

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 G​ itHub Project repository​ and provide a link to
your forked GitHub repository here:

GitHub Repository Link

<Add a link to your forked GitHub project repository>

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 <insert the repository link
repository. you provided above>

B. Move your bikeshare.py and data files into No git command needed (you can
your local repository. use c
​ p​ or a GUI)

C. Create a .gitignore file containing the name No git command needed (you can
of your data file. use t​ ouch​ 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


your files are not being tracked

F. Stage your changes.

G. Commit your changes with a descriptive


message.

H. Push your commit to your remote repository.


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


your local repository.

B. Switch to the d
​ ocumentation ​branch.

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


text in your README.md file)

D. Stage your changes.

E. Commit your work with a descriptive


message.

F. Push your commit to your remote repository


branch.

G. Switch back to the master branch.


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 d
​ ocumentation​ branch.

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


changes. When you commit your work, you
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


branch.

E. Switch back to the m


​ aster​ branch.

F. Check the local repository log to see how​ 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


local repository.

B. Switch to the r​ efactoring​ branch.

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


with a descriptive message of the changes
made.

E. Push your commits to your remote


repository branch.

F. Switch back to the m


​ aster​ branch.

G. Check the local repository log to see how​ 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 m
​ aster​ branch.

B. Pull the changes you and your coworkers


might have made in the passing days (in this
case, you won't have any updates, but pulling
changes is often the first thing you do each
day).

C. Since your changes are all ready to go, merge


all the branches into the master. Address any
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


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.

You might also like