Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.
Git “hook[ed]” on images
and up your
documentation game
@veronica_hanus @PyCaribbean
@veronica_hanus @PyCaribbean
Creative documentation
@veronica_hanus @PyCaribbean
View changes
remotely, feel
amazing and...
Push ASAP Commit
Make changes to code
locally
My f...
A timeline of a Very Visual Veronica
Always: “Documentation Lowers Cognitive Load”
Geology Web Workflows for ML
?
(what ne...
Iteration is not design!
What does a design process look like?
- Team “interview”
- Translate business
objectives to new
s...
Challenges of Git’s “time travel” w/ commits
“Picture perfect” commitsComment fatigue
- Summarize in subject (“what”),
exp...
- “Remove lighter
green font & add
underline to nav
bar”
- “Remove
lighter/brighter
font &...”
What commit message should ...
What would you do?
Better commit messages? Find tools giving cues? Other ways?
Your idea here
@veronica_hanus @PyCaribbean
Steps to roll back to a commit:
- Select the commit
- Find the ID for the commit
- Enter command to “checkout” the
commit ...
Screenshots in a local folder
One problem at a time
Color preview in-editor
@veronica_hanus @PyCaribbean
Screenshots in saved in Git
Moving toward a solution
What pain points does my solution
have?
How do I address these?
@vero...
Screenshots for testing… and tracking?
A few tools:
➔ Puppeteer-screenshot-tester
➔ Resemble.js
➔ Wraith
Screenshot diffin...
@veronica_hanus @PyCaribbean
A “Git” for design!
Our examples: Abstract’s Compare Mode, Sketch’s Pages & Artboards, Sketch’s Zeplin @veronica_hanus @Py...
Ready to dive in
Puppeteer or
Pyppeteer automate
screenshots
Git hooks “hook” one
action to others
Terminal prompt for
you...
Bring yourself
Geology Web Workflows for ML
?
(what next?)
@veronica_hanus @PyCaribbean
Keep in touch!
@veronica_hanus @PyCaribbean
Resources Thanks to…
Each of you for coming(!), the
PyCaribbean organizers for...
Credits
- Git instructions for beginners:
https://docs.google.com/document/d/1YZInGNW_YZQvTTsiOA1BkboveFzlez0TdlCjKIk4
UK0...
Upcoming SlideShare
Loading in …5
×

Git hooked on images and up your documentation game

60 views

Published on

*Can you remember the difference between two hex color values? Me neither!* Entering visual representations of recently-changed elements into version control makes review of past changes easier & speeds acclimation to a new web project, especially for visual learners. Surprisingly, methods for including images in your version control aren't standardized and are rarely used outside of large companies, and the rest of us are left checking out every major commit and viewing changes locally! Join me for a review of methods currently in use and discuss the benefits and drawbacks of each. The audience will learn from a survey of tools used by both designers and web developers, what methods are most appropriate for individual projects, & how these methods differ from those used at some of the largest companies (Google, eBay, etc.). Finding a method to track changes in your visual elements will save our future contributors (and future selves!) the pain of having to distinguish #2dc651 (lime green) from #34a34e (darker(!) lime green) and ultimately make our commit histories cleaner and our repos easier to navigate in ways that many of us have never imagined!
This talk was given at PyCaribbean 2019 in Santo Domingo, D.R..
Event link: http://pycaribbean.com/talk/git-hooked-on-images-and-up-your-documentation-game/

Published in: Software
  • Be the first to comment

  • Be the first to like this

Git hooked on images and up your documentation game

  1. 1. Git “hook[ed]” on images and up your documentation game @veronica_hanus @PyCaribbean
  2. 2. @veronica_hanus @PyCaribbean Creative documentation
  3. 3. @veronica_hanus @PyCaribbean View changes remotely, feel amazing and... Push ASAP Commit Make changes to code locally My first year learning to use Git Veronica’s early Git workflow A more thorough daily flow: - Pull other’s changes - Create branch / checkout branch - Local changes - Commit - Push when element is done - Check status - Continue local changes - (eventually) Merge branch You may also: - Undo commits - Squash commits - Undo push - Fetch - Rebase
  4. 4. A timeline of a Very Visual Veronica Always: “Documentation Lowers Cognitive Load” Geology Web Workflows for ML ? (what next?) @veronica_hanus @PyCaribbean
  5. 5. Iteration is not design! What does a design process look like? - Team “interview” - Translate business objectives to new state - ID what you don’t know - Review existing market product - Brainstorming - Listing user tasks - Roadmap - Focus group - Card sorting - Usability test - Concept testing - Guerrilla testing - Field studies - Eye movement tracking - Accessibility audit - A/B testing - (finally) Iteration Design has methods & tools! @veronica_hanus @PyCaribbean
  6. 6. Challenges of Git’s “time travel” w/ commits “Picture perfect” commitsComment fatigue - Summarize in subject (“what”), expand in body (“why”) - Avoid abbreviations - Use metadata (Issue IDs, etc.) - The test: “If applied, this commit will *subject line*” - Make Git log useful! @veronica_hanus @PyCaribbean
  7. 7. - “Remove lighter green font & add underline to nav bar” - “Remove lighter/brighter font &...” What commit message should we make? So many greens! Long and still hard to understand! @veronica_hanus @PyCaribbean
  8. 8. What would you do? Better commit messages? Find tools giving cues? Other ways? Your idea here @veronica_hanus @PyCaribbean
  9. 9. Steps to roll back to a commit: - Select the commit - Find the ID for the commit - Enter command to “checkout” the commit with that ID - Open the code & HTML file - Is it what we want? - Create new branch (section of timeline) before making changes Rolling back individual commits @veronica_hanus @PyCaribbean
  10. 10. Screenshots in a local folder One problem at a time Color preview in-editor @veronica_hanus @PyCaribbean
  11. 11. Screenshots in saved in Git Moving toward a solution What pain points does my solution have? How do I address these? @veronica_hanus @PyCaribbean
  12. 12. Screenshots for testing… and tracking? A few tools: ➔ Puppeteer-screenshot-tester ➔ Resemble.js ➔ Wraith Screenshot diffing @veronica_hanus @PyCaribbean
  13. 13. @veronica_hanus @PyCaribbean
  14. 14. A “Git” for design! Our examples: Abstract’s Compare Mode, Sketch’s Pages & Artboards, Sketch’s Zeplin @veronica_hanus @PyCaribbean
  15. 15. Ready to dive in Puppeteer or Pyppeteer automate screenshots Git hooks “hook” one action to others Terminal prompt for you to save by hand Time to take screenshots Remembering to take screenshots Adding image link to your commit message Pain Investigate Your commit to Git Git hook calls Pyppeteer Pyppeteer takes screenshot Terminal prompts you to save @veronica_hanus @PyCaribbean
  16. 16. Bring yourself Geology Web Workflows for ML ? (what next?) @veronica_hanus @PyCaribbean
  17. 17. Keep in touch! @veronica_hanus @PyCaribbean Resources Thanks to… Each of you for coming(!), the PyCaribbean organizers for a wonderful event, my crew Kasey Wang, Deborah Hanus, Diego Berrocal, & Anna Ossowski for help investigating this topic ➔ Puppeteer/Selenium/WebDriver for screenshots taken at every change ➔ Abstract/Zeplin/Sketch for scroll- through visuals to be used alongside your version control ➔ Hand-created screenshots checked into version control ➔ Editor plugins that help you visualize the colors on your site ➔ Your knowledge of your process & workflow for deciding what is right for you Let’s talk about in-code comments! (3-5 min survey) http://bit.ly/comment-use
  18. 18. Credits - Git instructions for beginners: https://docs.google.com/document/d/1YZInGNW_YZQvTTsiOA1BkboveFzlez0TdlCjKIk4 UK0/edit?usp=sharing - Daily Git commands: https://gist.github.com/jedmao/5053440 - Commit XKCD: https://xkcd.com/1296/ - Good commit messages: https://chris.beams.io/posts/git-commit/ - Color preview in-editor: Sublime’s Color Highlighter (view), Atom’s Pigments (view) & Color Picker (select/add) - Source for screenshot diffing images: https://online-image-comparison.com/ - “Automated visual diffing with Puppeteer” (2018), Monica Dinculescue’s blog https://bit.ly/2C3z25t - Grumpy cat says “no new friends” https://makeameme.org/meme/no-new-friends-0lalol @veronica_hanus @PyCaribbean

×