Open Design: Difference between revisions

Open Design (view source)

Revision as of 01:37, 23 October 2015

878 bytes added , 23 October 2015

formatting

Ezoehunt

Confirmed users

195

edits

@@ Line 111: / Line 111: @@
 :2. '''Go to ''Repository > Pull''.'''
-::This grabs any files from the remote Alopex repo that differ from what you have in your local repo.
+::As other people work on and push files to the remote repo, your local repo will become out of sync with the remote repo.
+::Before you push to Github, make sure you have the latest project files. When you "pull" from the remote repo, Github Desktop looks at the difference between files in your local repo and files on the remote repo. If there is a difference, Github Desktop copies them to your local repo when you go to ''Repository > Pull.''
+::[[File:repo pull.png|none|550px|Repo Pull]]
 :3. '''Confirm that your changes appear in your local repo.'''
-::If you've already exported your work (pdf, image, etc) into your local repo, Github Desktop will say "XX uncommitted changes."
+::If you've already exported your work (pdf, image, etc) into your local repo, the screen will say "XX uncommitted changes."
 :: If it doesn't say that, move (or copy) your changed files into your local repo.
 ::[[File:file_changed.png|none|550px|name]]
-:4. '''Describe your changes.'''
+:4. '''Switch to the "XX uncommitted changes" tab.'''
-:* If it's not already highlighted, click the ''"XX uncommitted changes"'' tab.
+::[[File:prepare commit.png|none|550px|name]]
-* Type a descriptive summary of your changes in the Summary input field.
-* Add a description in the Description field. Describe the difference between your changes and the current versions on the remote Github repo. For example, you could copy your Change Log details into the Description field.
-:5.* Note that the Summary and Description text are displayed in Github History, so other people can see what you’ve changed.
+:5. '''Prepare your commit.'''
+::"Committing" means you are saving a particular state of your local repo. If you changed just one file, your commit consists only of that file. If you changed several files, your commit consists of all the changed files.
+::* Enter a title for your commit in the Summary field. For example, Updated PTW spec."
+::* Enter a longer description for your commit in the Description field. Here you can describe the difference between your changes and the current versions on the remote Github repo. For example, you could copy your Change Log details into the Description field.
+::: *Note: the Summary and Description are displayed on the Github remote repo, so other people can see what you’ve changed.*
+::[[File:commit info.png|none|550px|name]]
-:6. '''Commit (save) your local repo.''' When you're satisfied that you've got all the changes you want included in this commit, and you’re satisfied with the Summary and Description, click "Commit to master." Your changes are now saved as a package in your local repo.
+:6. '''Commit to your local repo.'''
+::When you're satisfied that you've got all the changes you want included in this commit, and you’re satisfied with the Summary and Description, click "Commit to master."
+::[[File:commit info 2.png|none|550px|name]]
 :7. '''Push to Github.''' Go to ''Repository>Push.'' This immediately sends the package of changes to the remote Github repo and creates a new version for each changed file.
+::[[File:committed.png|none|550px|name]]
+::If you switch to the History tab, you'll see your commit at the top of the history.
+::[[File:committed 2.png|none|550px|name]]
 :8. '''Confirm your changes on Github.''' Visit the remote repo on the web and browse the folders where you expect to see the changed files. If it doesn't look the way you expect it to, repeat Steps 2-7. ''Note: once you get used to using Github, you probably won't need to do this step.''