Skip to content

Instantly share code, notes, and snippets.

@hayduke19us

hayduke19us/README.md

Created October 13, 2014 21:52
Show Gist options
  • Save hayduke19us/e60fcfc8e2198d75d5dd to your computer and use it in GitHub Desktop.
Save hayduke19us/e60fcfc8e2198d75d5dd to your computer and use it in GitHub Desktop.
Download ZIP
Raw
README.md

##Field Journel Docs

We will document all software development by following this pattern.

git clone https://github.com/Paradigmisr/field_journel_docs.git

When creating new files follow this pattern

Routing: append Routing.md

Iterations: /Iterations/iteration_name.md

  • sprints with notes about whom the sprint was assigned to, Issues etc.

Classes: /Models/class_name.md or /Models/Modules/module_name.md

  • Class or Module overview with all methods, constants dependencies and mixins

Controllers: /Controllers/class_name.md or Controllers/module_name.md

  • Class or Module overview with all private methods, constants dependencies and mixins

Views: /Views/method_name.md

  • partials
  • instance variables

Dependencies: /Dependencies/gem_name.md or third_party_name.md

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