You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
There are a tonne of badges that can show us what languages / frameworks we use, what the current test results are on CI, what version is currently available etc, which I think all add nice readability.
Can we do this for:
We want the following out of our README.md
How to Setup
Explanation of what it does
How it interfaces with other COVIDWatch / external repos
How testing works
How to Contribute
Badges
Lets add some cool badges:
https://gist.github.com/tterb/982ae14a9307b80117dbf49f624ce0e8
FAQ
When people are unsure lets populate this with some obvious answers
Contributors / Contacts
Link to the COVIDWatch Slack or how to email to get access / invites
@name's of people you can contact for help regarding the project.
Heres an example of some stuff I did in the cloud functions readme:
https://github.com/covid19risk/covidwatch-cloud-functions
The text was updated successfully, but these errors were encountered: