Cheat sheet: command line steps

Standard process (working from master)

Follow the steps in this article to create a local working branch on your computer so that you can create a new article or update and existing one. These steps list the Azure technical documentation repo, but you can substitute other repos in the commands.

  1. Start Git Bash (or the command-line tool you use for Git).

    Note: If you are working in the public repository, change azure-docs-pr to azure-docs in all the commands.

  2. Change to azure-docs-pr:

     cd azure-docs-pr
    
  3. Check out the master branch:

     git checkout master
    
  4. Create a fresh local working branch derived from the master branch:

     git pull upstream master
     git checkout -B <working branch>
    
  5. Let your fork know you created the local working branch:

     git push origin <working branch>
    
  6. Create your new article or make changes to an existing article. Use Windows Explorer to open and create new markdown files. After you create or modify your article and images, go to the next step.
  7. Add and commit the changes you made:

     git add --all
     git commit –m "<comment>"
    

    Or, to add only the specific files you modified:

     git add <file path>
     git commit –m "<comment>"
    
  8. Update your local working branch with changes from the upstream master branch:

     git pull upstream master
    
  9. Push the changes to your fork on GitHub:

     git push origin <working branch>
    
  10. When you are ready to submit your content to the upstream master branch for staging, validation, and/or publishing, in the GitHub UI, create a pull request from your fork to the master branch.

  11. If you are an employee working in the private repository, the changes you submit are automatically staged and a staging link is written to the pull request. Please review your staged content and sign off in the pull request comments by adding the #sign-off comment. This indicates the changes are ready for review and to be pushed live -- if they meet the criteria.
  12. If your update is small in scope, the PR may qualify for automatic merge. If not, the pull request review team reviews your pull request, provides feedback, and merges it if the PR meets the minimum quality criteria.