Giter Club home page Giter Club logo

git-sketch-plugin's Introduction

git-sketch-plugin

A Git client built right into Sketch. Generate pretty diffs so that everybody knows what are the changes!

From ... Ugly

... To Pretty

screen cast

Requirements

  • Sketch >= 3.4 (not with the sandboxed version ie from the App Store).
  • Git

Installation

  • Download this repo as a zip
  • Double-click on Git.sketchplugin

Workflow

Once:

  • Init the git repo
  • Add all the sketch files you are working on the repo

Then:

  • Create a new branch when you start working on a new feature
  • Work normally on your design
  • Save the file
  • Commit the changes with a meaningful message describing them. The plugin will extract the artboards in your file in order to show the differences easily.
  • Push your changes to the remote.
  • Create a pull request from your branch to the master branch.
  • Voila. Your co-workers can review the changes, comment on them and approve them. Once approved, merge the pull request.

For a more in-depth explanation of a nice git flow, check out this article.

Enabling Git LFS

Note: This is optional. In using the Git LFS extension, all contributors must have it installed, and the git remote (ie Github, Bitbucket, Gitlab) must have it enabled with sufficient storage available to the hosting account.

Git LFS is an extension for git that enables a quicker way to push and pull changes that involve binary files, like .png and .sketch. It is not critical to using this plugin, but it may help maintain a healthy git repository.

Start by enabling LFS for your repo:

  1. Downloading and install Git LFS to your machine
  2. Go into the terminal for your repo (through Sketch, Plugins > Git > Open terminal)
  3. Paste the following into your repo, git lfs install && git lfs track '*.png' && git lfs track '*.sketch' && git add .gitattributes
  4. Thats it. You need only run these commands once. Your team mates will have to download and install Git LFS onto their machines as well (so, just step 1).

Default key bindings

Action Shortcut
Commit your changes ctrl + alt + cmd + c
Push your changes ctrl + alt + cmd + p
Create a new branch ctrl + alt + cmd + n
Switch to an existing branch ctrl + alt + cmd + o

Git command behind

Client Command
Commit git commit -m 'message' -a
Push git push -q
New Branch git checkout -qb branchName
Switch Branch git checkout -q branchName
Add file to git git add currentFile
Init Git repo git init && git add currentFile

License

MIT

git-sketch-plugin's People

Contributors

mathieudutour avatar loklaan avatar alienresident avatar

Watchers

 avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.