github-quickstart

NAMESPACE: me.hegland-lance

PURPOSE: Practice using VSCode, Git, and GitHub tools while testing development environment installation and configuration of VSCode, Git, and GitHub.

.

Table of Contents

• Features
• Background
• Known Issues
• Requirements
• Installation
• Configuration
• Usage
• Authors
• Roadmap
• License

.

Features

Quick and easy practice and testing of VSCode, Git, and GitHub tools, including the following:

• creating local and remote GitHub repositories, including branching, plus a pull request and merge

• using VSCode to update common project files, including the following:

  • README.md
  • LICENSE.txt
  • .gitignore

• using the following Git features

  Command	Tutorial	Git Ref
  init	Link	Link
  status	Link	Link
  diff	Link	Link
  add	Link	Link
  commit	Link	Link
  remote	Link	Link
  push	Link	Link
  clone	Link	Link
  checkout	Link	Link
  branch	Link	Link
  fetch	Link	Link
  merge	Link	Link
  cmd	Link	Link
  cmd	Link	Link
  cmd	Link	Link
  cmd	Link	Link

  See also .gitignore.

.

Background

Lance Hegland wanted to test his local development environment, including the following tools:

• VSCode
• Git
• GitHub

.

Known Issues

None

.

Requirements

1. Familiarity and access to recent versions of the following development tools:

   Tool	Download	Reference	with VSCode
   VSCode	Link	Link
   + Markdown Preview Github Styling	Link
   + GitHub Pull Requests and Issues	Link
   Git	Link	Link	Link
   GitHub		Link	Link

.

Installation

None

.

Configuration

None

.

Usage

1. Review README.md for GitHub user LHHegland repository github-quickstart
2. Let's pretend that Dakota Smith creates a simulated project

   1. From the local projects directory, create a local working area github-quickstart (git init github-quickstart)

   2. Copy and update README.md

   3. Copy LICENSE.txt

   4. Review repository differences (working vs. staging)

      1. Review staging vs working areas (git status)

   5. Update working area to staging area (git add --verbose --all)

   6. Review repository differences (working vs. staging vs. commits vs. remote)

      1. Review staging vs working areas (git status)
      2. Review commit history (git log --oneline)
      3. Review commit change summary by file (git log --stat)
      4. Review brief commit messages by author (git shortlog)
      5. Review commit diagram (git log --graph --oneline --decorate)
      6. Review commit changes by file (git log -p)
      7. Review last commit vs working (git diff)
      8. Review last commit vs staging (git diff --cached)

↑ ↑ ↑ COMPLETED ↑ ↑ ↑ ↓ ↓ ↓ TO DO ↓ ↓ ↓

1. Review repository differences (working vs. staging vs. commits vs. remote)
2. Update staging area to commits area (git commit --message="Initial Commit with Base Files by Dakota Smith — dsmith@domain.tld — 555-987-2160")
3. Review repository differences (working vs. staging vs. commits vs. remote)
4. Create remote GitHub repository LHHegland/github-quickstart
5. Connect to that remote repository (git remote add origin git@github.com:LHHegland/github-quickstart.git)
6. Verify remote repository (git remote -v)
7. Update remote repository (git push -u origin master)
8. Review repository differences (working vs. staging vs. commits vs. remote)
9. Create text content documents with 70-character lines in working area
   1. file-a.txt containing 3 paragraphs of sample text from Lorem Ipsum
   2. file-b.txt containing 3 paragraphs of sample text from Lorem Ipsum
   3. file-d.txt containing 3 paragraphs of sample text from Lorem Ipsum
   4. file-j.txt containing 3 paragraphs of sample text from Lorem Ipsum
   5. file-t.txt containing 3 paragraphs of sample text from Lorem Ipsum
   6. file-z.txt containing 3 paragraphs of sample text from Lorem Ipsum
10. Create .gitignore listing file-j.txt
11. Review repository differences (working vs. staging vs. commits vs. remote)
12. Update working area to staging area (git add --verbose --all)
13. Review repository differences (working vs. staging vs. commits vs. remote)
14. Update staging area to commits area (git commit --message="Created ABDJTZ Feature by Dakota Smith — dsmith@domain.tld — 555-987-2160")
15. Review repository differences (working vs. staging vs. commits vs. remote)
16. Update remote repository (git push -u origin master)
17. Review repository differences (working vs. staging vs. commits vs. remote)
18. Then, Pat Doe creates a new feature in their local working area github-quickstart-rev-qtz

    Typically, a contributor would fork the remote repository into a new remote repository then use git fetch to gather and update the relevant files. However, GitHub doesn't allow a user to fork their own repositories. So, we will use a branch.

    1. From the local projects directory, copy the entire remote GitHub repository LHHegland/github-quickstart into a local working area (git clone git@github.com:LHHegland/github-quickstart.git github-quickstart-rev-qtz)
    2. Verify remote repository (git remote -v)
    3. Review existing branches (git branch --list)
    4. Checkout the master branch into a new branch rev-qtz (git checkout -b rev-qtz)
    5. Review existing branches (git branch --list)
    6. Perform the changes
       1. Create text content document file-q.txt with 70-character lines containing 3 paragraphs of sample text from Lorem Ipsum
       2. Update file-z.txt
          1. Edit line 26 at column 55 to replace "diam" with "quis"
          2. Edit line 7 starting with column 15 to delete "ultrices, "
          3. Edit line 13 starting with column 10 to replace "r" with "n"
          4. Edit starting with line 23 column 49 to replace "Sed ornare leo eu ex mollis ullamcorper. Phasellus ultrices tristique molestie. Fusce ipsum orci, vehicula et sodales aliquet, placerat non justo." through line 25 column 54 with "Donec porta posuere nisi eu gravida. Pellentesque in ullamcorper diam, ut efficitur elit. Cras lobortis convallis elit, sed accumsan ligula."
          5. Insert " Ut et risus id diam." at the end of line 10
       3. Delete file-t.txt
       4. Review repository differences (working vs. staging vs. commits vs. remote)
       5. Update working area to staging area (git add --verbose --all)
       6. Review repository differences (working vs. staging vs. commits vs. remote)
       7. Update staging area to commits area (git commit --message="Add Feature Q, Delete Feature T, Update Feature Z by Pat Doe — pdoe@domain.tld — 555-987-6543")
       8. Review repository differences (working vs. staging vs. commits vs. remote)
       9. Update branch rev-qtz in remote repository (git push -u origin rev-qtz)
       10. Review repository differences (working vs. staging vs. commits vs. remote)
19. While Pat Doe was creating the new feature, Dakota Smith worked on an unrelated new feature in their local working area github-quickstart
    1. Review existing branches (git branch --list)
    2. Fetch the updated remote repository (git fetch)
    3. Review existing branches (git branch --list)
    4. Checkout the master branch into the working area (git checkout master -f)
    5. Perform the changes
       1. Create text content document file-g.txt with 70-character lines containing 3 paragraphs of sample text from Lorem Ipsum
       2. Delete file-d.txt
       3. Update file-a.txt
          1. Edit line 17 starting with column 19 to replace "Phasellus in pulvinar mi. Sed molestie nisi quis erat bibendum, vitae tincidunt orci mollis. Etiam et nunc scelerisque, semper elit id, lacinia eros." through line 19 column 29 with "Praesent interdum lacus ac lacus vulputate condimentum. Vivamus tincidunt varius orci, at condimentum sapien efficitur sit amet."
          2. Insert " Pharetra nibh." at the end of line 21.
          3. Edit line 7 starting with column 31 to replace "e" with "i"
          4. Edit line 25 starting with column 35 to delete "non "
          5. Edit line 13 starting with column 15 to replace "elit" with "nunc"
    6. Review repository differences (working vs. staging vs. commits vs. remote)
    7. Update working area to staging area (git add --verbose --all)
    8. Review repository differences (working vs. staging vs. commits vs. remote)
    9. Verify remote repository (git remote -v)
    10. Review existing branches (git branch --list)
    11. Fetch the updated remote repository (git fetch)
    12. Verify remote repository (git remote -v)
    13. Review existing branches (git branch --list)
    14. Review repository differences (working vs. staging vs. commits vs. remote)
    15. Update staging area to commits area (git commit --message="Add Feature G, Delete Feature D, Update Feature A by Dakota Smith — dsmith@domain.tld — 555-987-2160")
    16. Review repository differences (working vs. staging vs. commits vs. remote)
    17. Update master branch remote repository (git push -u origin master)
    18. Review repository differences (working vs. staging vs. commits vs. remote)
20. While Dakota Smith was working, Pat Doe created a pull request to merge rev-qtz branch into master branch
    1. Create pull request to merge rev-qtz branch into master branch with the following message:

       Please consider merging this update into the github-quickstart application for expanded capabilities, improved ease of use, more efficient processing, and improved readability. This update adds feature Q, which more efficiently includes and replaces feature T plus required update to Feature Z. Thank you for developing this powerful application and your consideration of this potentially helpful update. Please contact me with any concerns or questions. Sincerely, Pat Doe — pdoe@domain.tld — 555-987-6543

       This revision includes the following changes:

       • Add file-q.txt
       • Delete file-t.txt
       • Modified file-z.txt
         • Edit line 7 starting with column 15 to delete "ultrices, "
         • Insert " Ut et risus id diam." at the end of line 10
         • Edit line 13 starting with column 10 to replace "r" with "n"
         • Edit starting with line 23 column 50 to replace "Sed ornare leo eu ex mollis ullamcorper. Phasellus ultrices tristique molestie. Fusce ipsum orci, vehicula et sodales aliquet, placerat non justo." through line 25 column 54 with "Donec porta posuere nisi eu gravida. Pellentesque in ullamcorper diam, ut efficitur elit. Cras lobortis convallis elit, sed accumsan ligula."
         • Edit line 26 at column 55 to replace "quis" with "diam"

21. Check to see if Dakota Smith can use git to merge rev-qtz branch into master branch correctly
22. troubleshoot if necessary
23. Dakota Smith notices, reviews, and responds to Pat Doe's pull request to merge rev-qtz branch into master branch
    1. Reply to and close this pull request saying:

       Before we can merge rev-qtz branch into master branch, we need to merge the most recent changes to the master branch into the rev-qtz branch to minimize potential conflicts and errors. Please review the pull request to merge the most recent changes from master branch into rev-qtz branch, preserving the desired changes in rev-qtz branch. Then, approve and merge if appropriate. Finally, submit a new pull request. If you have any questions or concerns, please contact Dakota Smith — dsmith@domain.tld — 555-987-2160. Thank you!

       The recent changes to the master branch are as follows:

       • Added file-g.txt
       • Deleted file-d.txt
       • Updated file-a.txt
         • Edited line 7 starting with column 31 to replace "e" with "i"
         • Edited line 13 starting with column 15 to replace "elit" with "nunc"
         • Edited line 17 starting with column 19 to replace "Phasellus in pulvinar mi. Sed molestie nisi quis erat bibendum, vitae tincidunt orci mollis. Etiam et nunc scelerisque, semper elit id, lacinia eros." through line 19 column 29 with "Praesent interdum lacus ac lacus vulputate condimentum. Vivamus tincidunt varius orci, at condimentum sapien efficitur sit amet."
         • Inserted " Pharetra nibh." at the end of line 21.
         • Edited line 25 starting with column 35 to delete "non "

24. Pat Doe reviews and integrates master branch changes into rev-qtz branch while preserving desired new feature changes
    1. Fetch the updated remote repository (git fetch)
    2. Checkout the rev-qtz branch into the working area (git checkout rev-qtz -f)
    3. Verify remote repository (git remote -v)
    4. Review existing branches (git branch --list)
    5. Review master branch vs working area (git diff master)

• merge ADGQTZ |\

• | add feature ADG | * add feature QTZ |/

• add feature ABDTZ

• initial files

  1. Merge the master branch changes into the rev-qtz branch (git merge --no-ff master)
  2. ERROR
  3. Review repository differences (working vs. staging vs. commits vs. remote)
  4. Update working area to staging area (git add --verbose --all)
  5. Review repository differences (working vs. staging vs. commits vs. remote)
  6. Update staging area to commits area (git commit --message="Merge recent master branch changes, preserving desired feature changes by Pat Doe — pdoe@domain.tld — 555-987-6543")
  7. Review repository differences (working vs. staging vs. commits vs. remote)
  8. Update branch rev-qtz in remote repository (git push -u origin rev-qtz)
  9. Create another pull request to merge rev-qtz branch into master branch with the following message:

     Included requested master branch changes into rev-qtz branch.

     Please consider merging this update into the github-quickstart application for expanded capabilities, improved ease of use, more efficient processing, and improved readability. This update adds feature Q, which more efficiently includes and replaces feature T plus required update to Feature Z. Thank you for developing this powerful application and your consideration of this potentially helpful update. Please contact me with any concerns or questions. Sincerely, Pat Doe — pdoe@domain.tld — 555-987-6543

     This revision includes the following changes:

     • Add file-q.txt
     • Delete file-t.txt
     • Modified file-z.txt
       • Edit line 7 starting with column 15 to delete "ultrices, "
       • Insert " Ut et risus id diam." at the end of line 10
       • Edit line 13 starting with column 10 to replace "r" with "n"
       • Edit starting with line 23 column 50 to replace "Sed ornare leo eu ex mollis ullamcorper. Phasellus ultrices tristique molestie. Fusce ipsum orci, vehicula et sodales aliquet, placerat non justo." through line 25 column 54 with "Donec porta posuere nisi eu gravida. Pellentesque in ullamcorper diam, ut efficitur elit. Cras lobortis convallis elit, sed accumsan ligula."
       • Edit line 26 at column 55 to replace "quis" with "diam"

  10. Delete local working area github-quickstart-temp

1. Dakota Smith reviews, merges, and responds to Pat Doe's latest pull request to merge rev-qtz branch into master branch
   1. Reply to, merge, and close this pull request saying:

      Reviewed and merged rev-qtz branch into master branch by Dakota Smith — dsmith@domain.tld — 555-987-2160. Thank you!

   2. Prune (delete) rev-qtz branch
   3. Delete local working area github-quickstart-rev-qtz
2. Clean-up local working area and remote repository
   1. Delete local working area github-quickstart-orig
   2. Delete remote repository github-quickstart
   3. Delete local working area github-quickstart

References:

• Git Basics Videos Episode 3: Get Going with Git
• Working with GitHub in VS Code
• GitPracticeV2 Project Branch Master
• Set up Git
• Create a repo
  1. Fork a repo
  2. GitHub flow
  3. Contributing to projects
  4. Be social
  5. Communicating on GitHub
  6. GitHub glossary
  7. Git cheatsheet
  8. Git and GitHub learning resources

1. Create hegland-lance workspace
2. Create Git Project github-test (git init github-test)
3. (git remote add [name] [URL])
4. Create repository content

.

Authors

• Lance Hegland (lance.hegland@gmail.com)

.

Roadmap

None

.

License

GNU General Public License v3.0 (GNU GPLv3)

• See LICENSE.txt
• See GNU General Public License v3.0 (GNU GPLv3)