Skip to content

Latest commit

 

History

History
23 lines (16 loc) · 736 Bytes

HACKING.md

File metadata and controls

23 lines (16 loc) · 736 Bytes

HACKING

Some quick documentation for hackery of pump.io.

JAVASCRIPT

  • jshint should run without errors.
  • idiomatic.js is about right, with below exceptions.
  • 4-character indent, spaces only (no tabs).
  • double-quotes for strings.
  • No internal space for parentheses; so "if (foo)", not "if ( foo )".
  • Use Step.
  • Use Underscore.
  • Use databank. Don't write to some storage engine's API.
  • Use vows.

GENERAL

  • Write tests first. Or, at least, soon after.
  • Use github issues to track issues.
  • Use Markdown for documentation.