Open Design: Difference between revisions

11 bytes removed ,  23 October 2015
adding screenshots
m (formatting)
(adding screenshots)
Line 103: Line 103:


<hr>
<hr>
=== Pushing to Github ===
=== Push to Github ===
This workflow is a simplified way to interact with Github. We're using this approach so team members who aren't familiar with Github can get used to it, before we move on to more sophisticated methods.
This workflow is a simplified way to interact with Github. We're using this approach so team members who aren't familiar with Github can get used to it, before we move on to more sophisticated methods.


In this workflow, you're pushing directly to the master branch (source of truth) with no 2nd person review. As with Dropbox and Box, it’s possible to overwrite someone else’s changes to the same file if you’re not careful.  
In this workflow, you're pushing directly to the master Github branch with no 2nd person review. As with Dropbox and Box, it’s possible to overwrite someone else’s changes to the same file if you’re not careful.  


:1. '''Open Github Desktop client.'''
:1. '''Open Github Desktop.'''


:2. '''Get latest files from Github.'''
:2. '''Go to ''Repository > Pull''.'''  
::Go to ''Repository>Pull.''
::This grabs any files from the remote Alopex repo that differ from what you have in your local repo.
::This grabs any files from the remote repo that differ from what you have in your local repo.


:3. '''Confirm that your changes appear in your local repo.'''
: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 it doesn't say that, move (or copy) your changed files into your local repo.
::[[File:1change.png|none|550px|name]]
:4. '''Describe your changes.'''
:* If it's not already highlighted, click the ''"XX uncommitted changes"'' tab.
* 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.
: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.
: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.
: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.''


:4. If you've already exported your pdf (or image) into your local repo, the top bar of the Github Desktop client will say "XX uncommitted changes."
#* If it doesn't say that, move (or copy) your changed files into your local repo.
# '''Describe your changes.'''
#* If it's not already highlighted, click the ''"XX uncommitted changes"'' tab.
#* 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.
#* Note that the Summary and Description text are displayed in Github History, so other people can see what you’ve changed.
# '''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.
# '''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.
# '''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.''


''Tips:''
''Tips:''
Line 134: Line 139:


<hr>
<hr>
=== Gathering Feedback from Team and Collaborators ===
=== Gathering Feedback from Team and Collaborators ===
All files in the remote Github repo are visible to anyone on the web. So people can browse the repo and look at your files if they want to get an update on the project. But we'll get more (and more effective) feedback if we actively solicit it.
All files in the remote Github repo are visible to anyone on the web. So people can browse the repo and look at your files if they want to get an update on the project. But we'll get more (and more effective) feedback if we actively solicit it.
Confirmed users
195

edits