Confirmed users
195
edits
Open Design: Difference between revisions
Jump to navigation
Jump to search
m
formatting
m (better formatting) |
m (formatting) |
||
| Line 1: | Line 1: | ||
< intro here> | < intro here> | ||
== Create a Github Account == | == Create a Github Account == | ||
# Create your account at [http://www.github.com Github.com] | # Create your account at [http://www.github.com Github.com] | ||
# Email your Github handle to ehunt@mozilla.com - she'll add you to the Github org as a Member. | # Email your Github handle to ehunt@mozilla.com - she'll add you to the Github org as a Member. | ||
== Set up Github Desktop client == | == Set up Github Desktop client == | ||
| Line 17: | Line 17: | ||
# '''You're done!''' | # '''You're done!''' | ||
::[[File:Open design example folder structure.png|none|thumbnail|Example Directory Structure]] | ::[[File:Open design example folder structure.png|none|thumbnail|Example Directory Structure]] | ||
== Example Workflow == | == Example Workflow == | ||
# Create something you want to share in public. | # '''Create something you want to share in public.''' | ||
# For designers, export as pdf or image. For others, you might want to export as a pdf (e.g., if you've created slides) or just create text files - Github uses [https://help.github.com/articles/github-flavored-markdown/ Markdown], so it's easy to format docs in a nice way. | # '''Export files.''' | ||
#* For designers, export as pdf or image. | |||
#* For others, you might want to export as a pdf (e.g., if you've created slides) or just create text files - Github uses [https://help.github.com/articles/github-flavored-markdown/ Markdown], so it's easy to format docs in a nice way. | |||
#* If you were using the example directory structure above, you would export your file to ''Sites / FxOS_Product_Design / alopex / folder-name'' | #* If you were using the example directory structure above, you would export your file to ''Sites / FxOS_Product_Design / alopex / folder-name'' | ||
# | # '''Push to Github''' using instructions below. | ||
== Pushing to Github == | == Pushing to Github == | ||
This workflow is a simplified way to interact with Github. We're using this simplified 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 simplified 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 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. | ||
# Open Github Desktop client. | # '''Open Github Desktop client.''' | ||
# | # '''Get latest files from Github.''' In Github Desktop, go to ''Repository>Pull''. This grabs any files from the remote repo that differ from what you have in your local repo. | ||
#* '''Confirm that your changes appear in your local repo.''' | |||
#* 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 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, | #* If it doesn't say that, move (or copy) your changed files into your local repo. | ||
# If it's not already highlighted, click the ''"XX uncommitted changes"'' tab. | # '''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. | #* Type a descriptive summary of your changes in the Summary input field. | ||
#* Add a description of the changes 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. | #* Add a description of the changes 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. | #* Note that the Summary and Description text are displayed in Github History, so other people can see what you’ve changed. | ||
# When you're satisfied that you've got all the changes you want included in the 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. | # '''Commit (save) your local repo.'''When you're satisfied that you've got all the changes you want included in the 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. | ||
# Now 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. | # Now 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. | ||
# You can confirm that your changes appear in the remote Github repo by visiting the remote repo on the web and browsing the folders where you expect to see the changed files. | # You can confirm that your changes appear in the remote Github repo by visiting the remote repo on the web and browsing the folders where you expect to see the changed files. | ||