This is an example repository to illustrate different facets of documentation and the anatomy of an open source repo. Find example README.md files and other README-related resources towards the bottom of this file.
Note that this repo can also be used as a template to create your own repository.
- Community Health Files
- Workflows
- Issue Templates
- Pull Request Templates
- OpenAPI
- the OpenAPI examples in this repo were generated using Redocly's create-openapi-repo
GitHub allows people viewing your repository to easily access certain Community Health Files via the sidebar if they exist at the root level of your directory:
The README is the first thing a new contributor sees or reads when they encounter your project. It should contain an overview of your project and link to other places to learn about the project itself, its maintainers, and how contribution works.
This file has the .md extension, which means we can write using Markdown, a special syntax for formatting our text. You should utilize Markdown to organize, emphasize, and link to different parts of your documentation. Markdown even has some advanced features, like flow charts:
flowchart LR
a[user visits repo] --> b[user reads README] --> c[user contributes!]
Since we're using Markdown and you're viewing this file on GitHub 
, using headings (denoted with #) will automatically generate a table of contents for the README.md that exists at the root of your repository.
- https://github.com/18F/open-source-guide/blob/18f-pages/pages/making-readmes-readable.md
- https://github.com/matiassingers/awesome-readme
- GitHub Docs: About READMEs
The following is from @PurpleBooth's Example README
One Paragraph of project description goes here
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
What things you need to install the software and how to install them
Give examples
A step by step series of examples that tell you how to get a development env running
Say what the step will be
Give the example
And repeat
until finished
End with an example of getting some data out of the system or using it for a little demo
Explain how to run the automated tests for this system
Explain what these tests test and why
Give an example
Explain what these tests test and why
Give an example
Add additional notes about how to deploy this on a live system
Links to technologies your project relies on
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
We use SemVer for versioning. For the versions available, see the tags on this repository.
- Billie Thompson - Initial work - PurpleBooth
See also the list of contributors who participated in this project.
This project is licensed under the MIT License - see the LICENSE.md file for details
- Hat tip to anyone whose code was used
- Inspiration
- etc