Skip to content

Instantly share code, notes, and snippets.

@statonjr

statonjr/readme.markdown

Forked from jonah-williams/readme.markdown
Last active August 29, 2015 14:11
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 statonjr/c74914d199cad490407e to your computer and use it in GitHub Desktop.
Save statonjr/c74914d199cad490407e to your computer and use it in GitHub Desktop.
Download ZIP
Raw
readme.markdown

Project

Description: What does this project do and who does it serve?

Project Setup

How do I, as a developer, start working on the project?

  1. What dependencies does it have (where are they expressed) and how do I install them?
  2. How can I see the project working before I change anything?

Testing

How do I run the project's automated tests?

Unit Tests

  1. rake spec
  2. lein test
  3. lein midje

Integration Tests

  1. Run other local services / provide credentials for external services.
  2. rake spec:integration

Documentation

  1. Documentation about the code should reside in the doc directory
  2. Documentation about the project should reside in the GitHub Wiki

Deploying

How to setup the deployment environment

  • Required Travis setup
  • Required AWS setup
  • Required environment variables or credentials not included in git.
  • Monitoring services and logging.

How to deploy

Troubleshooting & Useful Tools

Examples of common tasks

e.g.

  • How to make curl requests while authenticated via oauth.
  • How to monitor background jobs.
  • How to run the app through a proxy.

Contributing changes

  • Internal git workflow
  • Pull request guidelines
  • Tracker project
  • Google group
  • irc channel
  • "Please open github issues"

Copyright year Hendrick Automotive Group

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