Add a README template for new repos

18F / open-source-policy

This repository contains the official Open Source Policy of 18F

https://18f.gsa.gov

Other

300 stars 94 forks source link

Add a README template for new repos #46

Closed stvnrlly closed 8 years ago

stvnrlly commented 8 years ago

This started out as a place to put information about branching structure, but also seemed like a good way to make README creation match the flow for LICENSE and CONTRIBUTING.

The heading structure is a little busy, in part because I assumed that the use of h3 in this repo for the "License" part of the README was intentional. If it can be bumped up to h2, that can probably be simplified

konklone commented 8 years ago

I left a comment, am otherwise :+1:. If you like either of my two suggestions, feel free to take them and merge, or we can discuss further.

stvnrlly commented 8 years ago

I chose to bump Public domain up to h2. The reason why I went with that approach is to keep a direct progression through header levels. While not strictly required for accessibility purposes, it seems to be a best practice.