Description: What does this project do and what audience is it intended for?
I like to add my CI badges here, since it helps everyone to easily see the health of the project
How do I, as a developer, start working on the project?
- What dependencies does it have (where are they expressed) and how do I install them?
- How can I see the project working before I change anything?
How do I run the project's automated tests?
e.g.
- How do I run integration tests?
- How do I run unit tests?
How do I, as a developer, setup the deployment environment?
e.g.
- Required heroku addons, packages, or chef recipes.
- Required environment variables or credentials not included in git.
- Monitoring services and logging.
How do I, as a developer, take advantage of any tooling you may have put in place; how can I easily debug, execute the project in weird scenarios, etc.
e.g.
- How to make curl requests while authenticated via oauth.
- How to monitor background jobs.
- How to run the app through a proxy.
- Git guildines for your project
- How you review code for your project
- Your projects coding practices
- Post your style guide
- Communication channels (IRC, Gittr badge, Google group)
- "Please open github issues" and other words of encouragement
MIT GNU etc