Based on the EDGI Repo Guidelines at https://github.com/edgi-govdata-archiving/overview/blob/main/repo_guidelines.md
- Instructions go here
- Developer setup (if relevant)
- Slack channel (if relevant)
Suggestions for additional components of Readmes:
- A "How to use" section if the repo's project is a tool or website
- A link to the good-first-issue label (this link across EDGI, or a specific link for the repo)
- Highlight "ready" label on issues to mean "this is an issue that is ready to work on and needs an owner"
- Additional badges at the top, such as code quality indicators
- "All contributors" listing, following these additional guidelines (example: web-monitoring-db contributors list):
- Compact representation without avatars (less visual noise; easier to focus on contributions)
- Icons are links with title attributes (accessibility)
- Alphabetical order by surname/name/username (to eliminate implied ranking)
- Presence in the list (and the name used) is optional and up to the contributor (not everyone wants to be listed — we offer, but do not add unless someone explicitly says yes)
When using this template, please look through all of the files to ensure they apply to the new repo.
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 3.0.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the LICENSE file for details.