Skip to content

Instantly share code, notes, and snippets.

@kiote
Created May 13, 2021 11:18
Show Gist options
  • Save kiote/30888952f5792883c9bc632517a6b64c to your computer and use it in GitHub Desktop.
Save kiote/30888952f5792883c9bc632517a6b64c to your computer and use it in GitHub Desktop.

How to write readmes for your projects

"Your" project is a project you happen to make any changes at. Any Readme can contain also extra parts, specific for a project.

Necessary parts

Underneath is a template you can use in a project without any (or with scaffolded) readme:

Intro

What this project is about, what problem it solves. General description.

Setup

How to run project locally

Contribution

How bug fixes are named? How feature-branches are named? Where pull requests should go (straight to master, develop branch)?

Deployment

How to deploy project

Useful URLs for testing

How to test project (URLs in different envs should go here)

Alerting, monitoring, logging

If project has some specific alerts, monitoring dashboards or logs, put it here

Related repos

If project directly relates to some other projects, put links here

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