IPP-DEV-01-100: Save Your Work

[labbenchstudios]

Description

• Verify your work by running all required tests, document your work, then commit and push your work using Git.

Review the README

• Please see README.md for further information on, and use of, this content.
• License for embedded documentation and source codes: IPP-DOC-LIC

Estimated effort may vary greatly

• The estimated level of effort for this exercise shown in the 'Estimate' section below is a very rough approximation. The actual level of effort may vary greatly depending on your development and test environment, experience with the requisite technologies, and many other factors.

Actions

• Use the lab module's README.md template to document your work.
• Review / verify any code updates within the Git repository / branch.
• Run all lab module unit and integration tests and ensure successful execution.
• Commit all updates locally, then push the updates to your remote.

Step 1: Document Your Work

• Each Lab Module path contains a README.md with an embedded template. Students taking the Intro to Programming in Python course should complete the documentation - using markdown notation - and save / commit the file.

Step 2: Commit Your Code and Docs to Local Storage

Commit and Push Source Code and Documentation

• You can commit and push your source code (and docs) using the IDE
• If you'd prefer to do so manually, use the following steps as a guide
  • Launch a terminal window
    • cd IPP_HOME
  • Commit and push your code
    • git add .
    • git commit .
      • You'll need to enter and save a commit message using the window that launches
    • git push

Step 3: Verify the Commit Was Successful

• From your exercise path (IPP_HOME), run the following command:
  • git log --oneline default
• The log displayed should include your latest commit message at the top indicating that git executed the request.

Estimate

• For this course, you'll likely be the only one working in your branch. Further, we'll use only one branch for the class - default. You're welcome to create others, but it is not required for the class.
• If there are no issues with the commands above, the entire process should only take 5 - 10 minutes.

Tests

• N/A