Merge pull request #829 from github-for-unity/docs/changes

Andreia Gaita · web-flow · commit 76b19f79c401 · 2018-06-15T17:29:14.000+01:00
Add documentation for working with changes
diff --git a/docs/using/images/changes-view.png b/docs/using/images/changes-view.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:2ac4637a222a06e6ab57f23082b8e8b2f5cb9e35b9b99776c112ddcebb923dec
+size 61918
diff --git a/docs/using/images/confirm-pull-changes.png b/docs/using/images/confirm-pull-changes.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:4b0e1aa1d8d86cb0264c9ca569a5c8e71b0aba73a2eb6611c06ec47670037d7d
+size 21478
diff --git a/docs/using/images/confirm-push-changes.png b/docs/using/images/confirm-push-changes.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:9e2e136027b03609f344bfde0c777d8e915544a5e9920f1268e4cc3abc5b1481
+size 18676
diff --git a/docs/using/images/confirm-revert.png b/docs/using/images/confirm-revert.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:ba990ce12403bfb53fb387ca3f3e2c447b21814ed6cd7e6f88d968463a5253a8
+size 21973
diff --git a/docs/using/images/post-commit-view.png b/docs/using/images/post-commit-view.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:91e26123236bdd3e692ca7d30ff0d6477311fe739d8008ba19fd543ee3506176
+size 21345
diff --git a/docs/using/images/post-push-history-view.png b/docs/using/images/post-push-history-view.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:c0c2d5ccaddc88d3268e0d57f02229525240ecc71bded951e23171456560268b
+size 22485
diff --git a/docs/using/images/pull-view.png b/docs/using/images/pull-view.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:feb83a46ebdd34ff46db3a38e8829f5adec5b10824bf69a8c56c9ba6fbd603ff
+size 25054
diff --git a/docs/using/images/push-view.png b/docs/using/images/push-view.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:ab87bae0916af3681b7528891a359c77597fa3ea57f13eb6924f1cbcf2f2ab7d
+size 14581
diff --git a/docs/using/images/revert-commit.png b/docs/using/images/revert-commit.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:b7711f428f3e04ea056c47b5d43109f3941761f4c286360d3616e0598d2d7b75
+size 26119
diff --git a/docs/using/images/revert.png b/docs/using/images/revert.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:dea7b36eec8e2d99e1906b6cbc9cd22f52d2db09cc1a0cf34563585720b6649d
+size 25141
diff --git a/docs/using/images/success-pull-changes.png b/docs/using/images/success-pull-changes.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:e0407ab83ca311f319ff7feac0dac84b862935e2b50353ff82c067bdadf80e16
+size 16888
diff --git a/docs/using/images/success-push-changes.png b/docs/using/images/success-push-changes.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:cfd290cb1e52b0acb5503642a3aaef164bf343735729325484e25d8b99293d7e
+size 13262
diff --git a/docs/using/working-with-changes.md b/docs/using/working-with-changes.md
@@ -0,0 +1,53 @@
+# Working with changes
+
+## Commit changes to GitHub
+
+All changes made to a repository will show up under the **Changes** view.
+
+1. Select the changes to be committed. Can choose the All/None options, or select directories or files individually.
+2. Enter a Commit summary which describes the purpose of the commit. An optional Commit description can also be entered.
+3. Click the button `Commit to [branch name]`.
+<img src="images/changes-view.png" alt="Changes view"/>
+
+The commit will not be shown under the **History** view. On the top bar the button `Push (1)` indicates that there is 1 commit to push.
+
+<img src="images/post-commit-view.png" alt="Post commit view"/>
+
+## Push changes to GitHub
+
+1. Click `Push` once ready to push a commit to GitHub.
+<img src="images/push-view.png" alt="Push view"/>
+
+2. A dialog will appear asking `Would you like to push changes to remote 'branch name'?` Select `Push`.
+<img src="images/confirm-push-changes.png" alt="Confirm push dialog"/>
+
+3. Another dialog will appear when the push to GitHub is complete saying `Branch pushed`. Select `ok`.
+<img src="images/success-push-changes.png" alt="Branch pushed"/>
+
+##  Revert changes
+
+1. From the **History** view, right-click on a commit in the commit list. A `Revert` option will appear.
+2. Click `Revert`.
+<img src="images/revert.png" alt="Revert"/>
+
+3. A dialog will appear asking `Are you sure you want to revert the following commit: "commit message"?`. Select `Revert`.
+<img src="images/confirm-revert.png" alt="Confirm revert dialog"/>
+
+4. A new commit appears titled `Revert "commit summary"` and the view indicates that there is 1 commit to push.
+<img src="images/revert-commit.png" alt="Revert commit"/>
+
+5. Follow the steps to push the reverted commit to GitHub.
+
+## Pulling changes
+
+1. Click the `Fetch` button to get all the latest branches and tags for the repository. The `Pull` button will then show the number of commits to pull from GitHub.
+2. Click `Pull`.
+<img src="images/pull-view.png" alt="Pull changes"/>
+
+3. A dialog will appear asking `Would you like to pull changes from remote 'branch name'?`. Select `Pull`.
+<img src="images/confirm-pull-changes.png" alt="Confirm pull changes dialog"/>
+
+4. Another dialog appears saying `Local branch is up to date with 'branch name'`. Select `ok`. 
+<img src="images/success-pull-changes.png" alt="Changes pulled"/>
+
+
