Workflow

Copyright (c) 2013 Bart Massey

"Workflow" is the pattern of work in a project, from input tasks through task processing and finally to work products.

• Inputs

  • Features, Defect Removal
    • Issue Tracker
    • TODO file
  • New ideas, exploration
  • Refactoring and redesign

• Outputs

  • Code
    • commits
    • patches
    • new projects / subprojects
  • Docs (lightweight)
    • comment-doc for given language
    • changelog (should summarize rather than repeating SCM log)
    • man pages
    • internal help documents for GUI apps
    • README
  • Deployments
    • repo tags
    • package manager for given language / community
    • web downloadables
    • self-deployment

• Initial Workflow

  • Define project
  • Create repo
  • Pick license
  • Tag all files with license / copyright
  • Upstream repo

• Day-to-day Workflow

  • Write code
  • Manage feature+defect queue
  • Commit code
  • Push/pull
  • Tag versions, branch repo
  • Work with Internet community
  • QA code
    • Inspection
    • Testing
  • Document

Note that "write code" is a really small item on a large list. These activities should pay for themselves in better coding productivity. Always give them a try before giving up on them.

Use these notes as a checklist of things to try. It's not complete, so add to it.