Skip to content

Tutorial for TechWriters to practice Github fundamentals

Notifications You must be signed in to change notification settings

puchki-chat07/Howdy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 

Repository files navigation

Tutorial 1: Proofread the Getting Started topic

  1. Open a terminal.
  2. Navigate to your Home folder (under Users > find folder with your user name).
  3. Create a folder in your Home folder. Name the folder as Github-Step1
  4. Clone the repo into the folder you just created.
    • To clone , run git clone git@github.com:puchki-chat07/Howdy.git to clone the repo.
    • Learn more about the git clone command. More details on how clone works. More like "behind-the-scene-effect" of the git clone command.
    • You can also copy the above clone command from GitHub. See this screenshot.
  5. Create a branch. The branch you create is associated to the folder you are in. Git will now track all changes you make to the files/folders stored under Github-Step1.
    • To create a new branch (and switch to the branch at the same time), run git checkout -b <branch_name>.
    • Learn more about git checkout command.
  6. Run git branch to verify that you are on the branch you just created.
  7. Run git status to verify that there are no uncommitted changes and your branch is up to date.
  8. Run git push origin <branch_name> to create a remote copy of your branch on GitHub.

Edit Content and commit the changes

  1. In your terminal run atom . to open atom and start proofediting and structuring the content following the Technical Writing best practices. See MSTP for reference.
  2. Run git add . to add the changes to your branch.
  3. Run git commit -a to add a brief details of the changes you made and that are ready to be committed.
  4. Run git push origin <branch_name>.
  5. Go to Github and click Create a pull request. See this screenshot for more instruction.
  6. Verify both the origin (master) and your branch that you want to merge. This merges your fork to master.
  7. Add comment.
  8. Click Merge Pull request.
  9. Click Confirm Merge to apply the changes to the repo.

Tutorial 2: Change the location of the Getting Started topic.

Once you are done, move the Getting Started to a new folder.

About

Tutorial for TechWriters to practice Github fundamentals

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published