Skip to content

Latest commit

 

History

History
45 lines (27 loc) · 1017 Bytes

README.md

File metadata and controls

45 lines (27 loc) · 1017 Bytes
Raw

Project

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

Include authorship, support contact and release information.

Project Setup, Installation, and Configuration

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. Can I see the project working before I change anything?

Testing

How do I run the project's automated tests?

  • Unit Tests

  • Integration Tests

Deploying

How to setup the deployment environment

  • Addons, packages, or other dependencies required for deployment.
  • 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

  • See CONTRIB.md

Licensing

  • See LICENSE.md