Skip to content

Instantly share code, notes, and snippets.

@joshdcomp

joshdcomp/repo-info.md

Last active May 13, 2016 18:03
Show Gist options
  • Save joshdcomp/1256806683016fb41c6a2f852f1a868a to your computer and use it in GitHub Desktop.
Save joshdcomp/1256806683016fb41c6a2f852f1a868a to your computer and use it in GitHub Desktop.
Download ZIP
Raw
repo-info.md

Readme

  • dependencies: environment requirements (eg: sass, grunt, ruby v2.4.1)
  • hello world: steps to get up and running

Wiki

  • workflow notes: general notes on the order of tasks, gotchas, branching strategies, etc
  • populating an environment: where to get a database/data, where to put the data, notes on changes you need to make to this data
  • handoff notes: information we need to convey to the client, things we'll need to train the client on doing
  • launch checklist: tasks developers would need to do as part of launching a project (eg: clear seeded data, set up admin accounts for client, set up pages/environment configs)
  • resources/helpful links
  • db diagram
  • routes/sitemap: route logic, description for what functionality lives on each endpoint
  • api documentation: endpoints and model responses

Issues

  • questions
  • needs (eg assets or designs)
  • tasks
  • bugs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment