Skip to content

Instantly share code, notes, and snippets.

@eseceve
Forked from jonah-williams/readme.markdown
Last active August 6, 2017 04:25
Show Gist options
  • Save eseceve/5675766 to your computer and use it in GitHub Desktop.
Save eseceve/5675766 to your computer and use it in GitHub Desktop.
Readme template for Github repository

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.

Roadmap

  • Next feature 1
  • Next feature 2
  • Next feature 3

####Changelog

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b feature/my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin feature/my-new-feature)
  5. Create new Pull Request

Project Team:

Acknowledgements

We are grateful to the maintainers, contributors, and sponsors of the following technologies which make Project possible:

contributors

Copyright and license

Copyright (c) 2012 ExactTarget

Licensed under the MIT License (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License in the COPYING file.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

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