Skip to content

Instantly share code, notes, and snippets.

@ghelobytes

ghelobytes/readme.markdown

Forked from jonah-williams/readme.markdown
Created April 11, 2014 07:59
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save ghelobytes/10448333 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save ghelobytes/10448333 to your computer and use it in GitHub Desktop.
Download ZIP

Revisions

  1. Jonah created this gist Jul 12, 2012.
    54 changes: 54 additions & 0 deletions readme.markdown
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,54 @@
    # _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`

    ### Integration Tests

    1. _Run other local services / provide credentials for external services._
    2. `rake spec:integration`

    ## Deploying

    ### _How to setup the deployment environment_

    - _Required heroku addons, packages, or chef recipes._
    - _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"_

    ## License