Skip to content

Instantly share code, notes, and snippets.

@vjpr

vjpr/code-snippets.md

Last active August 29, 2015 14:25
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save vjpr/1da8b6880c68074e8c9c to your computer and use it in GitHub Desktop.
Save vjpr/1da8b6880c68074e8c9c to your computer and use it in GitHub Desktop.
Download ZIP
What is the best workflow for posting code snippets?
Raw
code-snippets.md

What is the best workflow for posting code snippets?

My Gist Workflow

  • Use Gist plugin for Sublime Text 3. (Add api token to settings).
  • Create new files in ~/Desktop/Notes.
  • Use OmniMarkupPreview Sublime Text 3 plugin to preview in browser.
  • When ready...
  • Open command palette (⌘+Shift+P) > Enter Gist > Create New Gist. (Or use keyboard shortcuts)
  • Delete file from ~/Desktop/Notes.
  • Open it again using Gist Open from command palette.
  • Saving it will upload to Gist.

Considered

Goals

  • Discussion.
  • Revisioning.
  • Forking.
  • Quick edit.
  • See revisions.
  • Nice familiar editor. Sublime Text or IntelliJ for me.

Options

  • Gist
  • Quip
  • Github Issues
  • Native OSX app like Code Snippets
  • Sublime and file system
  • Github Wiki
  • Github Repo

Gist

Best.

Quip

Great collaboration. Fast desktop app. Terrible code support in documents - dealbreaker.

Github Issues

Bad editor support - cannot use Sublime to edit an issue. Good organization and search.

Native OSX app

Usually terrible inbuilt editors. No collaboration.

Sublime

Good editor. System search.

Github Wiki

Bad collaboration. No discussion.

Github Repo

Create a separate repo for discussion containing all design docs.

Commenting only at commit level. Heavy.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment