From d7f60447ecc79e723a87db1d5fa213f07874625f Mon Sep 17 00:00:00 2001 From: Andrew Schwartzmeyer Date: Thu, 7 Apr 2016 13:47:07 -0700 Subject: [PATCH] Quick markdown cleanups --- CONTRIBUTING.md | 12 +++++++----- docs/git/basics.md | 9 +++++---- docs/git/committing.md | 8 ++++---- 3 files changed, 16 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9f2af30e05..6ab29d575b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,8 +26,10 @@ New to Git? ----------- - [Git Basics](docs/git/basics.md): install and getting started. -- [Git for sd users](docs/git/source-depot.md): a handy reference document for people familiar with `sd`. -- [Commit process](docs/git/committing.md): step-by-step commit guide with all gory details. +- [Git for sd users](docs/git/source-depot.md): a handy reference + document for people familiar with `sd`. +- [Commit process](docs/git/committing.md): step-by-step commit guide + with all gory details. Authentication -------------- @@ -61,7 +63,7 @@ Particularly: [2 factor authentication]: https://github.com/blog/1614-two-factor-authentication [Branches](docs/workflow/branches.md) --------- +------------------------------------- * Checkout a new local branch for every change you want to make (bugfix, feature). * Use `alias/feature-name` pattern. @@ -116,12 +118,12 @@ git config --global am.threeWay true ``` [Mapping](docs/workflow/mapping.md) --------- +----------------------------------- Learn about new files locations in PowerShell/PowerShell. [Resources](docs/workflow/resources.md) --------- +--------------------------------------- Learn how to work with string resources in `.resx` files. diff --git a/docs/git/basics.md b/docs/git/basics.md index 727958ea96..c426cca165 100644 --- a/docs/git/basics.md +++ b/docs/git/basics.md @@ -1,10 +1,11 @@ # Git 101 -We are using git version 2.7.x, but any version should be good. -It's recommended to learn `git` command line tool for full cross-platform expirience. +We are using Git version 2.8.1, but any recent version should be good. +It's recommended to learn the `git` command line tool for full +cross-platform experience and a deeper understanding of Git itself. -There are (too) many git tutorials on the internet. -Here we post referrences to our favorites. +There are (too) many Git tutorials on the internet. Here we post +references to our favorites. ## Install diff --git a/docs/git/committing.md b/docs/git/committing.md index 555cff5bd1..f40bc865aa 100644 --- a/docs/git/committing.md +++ b/docs/git/committing.md @@ -39,10 +39,11 @@ index 1ba8dd4..ed5d202 160000 * Push the branch (in the SuperProject): `git push origin jim/colon-drive` * Pull request in the superproject to kick-in CI build and notify people. Reference submodule pull-request in the PR message to make navigation between two simpler. -### Commands log +Commands log +------------ Here is a transcript of command Jim used: -``` +```sh cd $HOME/PowerShell/src/monad/monad/src/engine vi DataStoreAdapter.cs git checkout -b jim/colon-drive @@ -50,11 +51,10 @@ git commit -a git push origin jim/colon-drive ``` then I went to the web interface and did the pull request *in the submodule*. After that, back to the commandline: -``` +```sh cd $HOME/PowerShell git checkout -b jim/colon-drive git commit -a git push origin jim/colon-drive ``` and back to the web interface for the pull request *in the superproject*. -