Skip to content

Instantly share code, notes, and snippets.

View joesustaric's full-sized avatar
💩
😴

Joe Sustaric joesustaric

💩
😴
View GitHub Profile
@joesustaric
joesustaric / README.md
Last active June 28, 2021 02:39
README.md for Enterprises

Readme Guide for Enterprise

Below is my example of a well structured Readme file for a code base maintained in an organisation. The ordering isn't that important but the information is. Linking out to other things can be ok although in my experience I believe things directly related to the code should live next to the code, including documentation.

FooBar

A short paragraph on what FooBar does. Be concise as possible.

Maintainers

Who owns FooBar or which team owns it? and/or Who knows the most about it? (link to contributors) or This code is unmaintained and looking for ownership.

Keybase proof

I hereby claim:

  • I am joesustaric on github.
  • I am mcbain83 (https://keybase.io/mcbain83) on keybase.
  • I have a public key ASDJA5_0ijhgQGMdTCo61ko1x5bfTu-AKChknDNLXm0vTQo

To claim this, I am signing this object: