Skip to content

Latest commit

 

History

History
74 lines (50 loc) · 4.6 KB

CONTRIBUTING.md

File metadata and controls

74 lines (50 loc) · 4.6 KB
Raw

Guiding Principles

We ask all contributors to please embrace the following principles while participating and when relevant:

  1. Be science-based - seek always primary sources
  2. Only provide information that can be acted upon
  3. Avoid politics, opinions, and personal comments
  4. Keep content clear and accessible
  5. Have empathy for all involved and avoid promoting fear
  6. Promote diversity and inclusion, especially the most vulnerable to COVID-19
  7. Collaborate with other groups to make information widely available
  8. Be the change ourselves

These guiding principles, as well as the project's code of conduct, represent the ways in which we expect our community to act.

How to contribute

This content is work in progress, please check back often as it will likely change. If you want to help, we currently need these roles - each with instructions describing how to make contributions such that updates can flow as efficiently as possible:

English Content Contributors

We need to keep the information updated with recent developments and recommendations. In this role you can edit any portion of content and create a pull request to have a reviewer confirm and approve your editing. See the following links for the English content for the home page and the act & prepare page. Under each of those folders, there is a subfolder for each topic, under which there are files for each section.

How to suggest an update or change

  1. If you have never used Github and are not comfortable trying to do the update yourself, please go here and fiil out an issue with your content change request or submission:
  2. If you have used Github before and know what Markdown is, you can make the change yourself.
  3. Identify a section that needs to be added or modified.
  4. Edit the content trying as best you can to match style and tone of the language used in that section - see instructions on how to edit content here.
  5. Before submitting a change request, please check the open pull requests to make sure that the same request has not yet been completed by someone else
  6. Include a comment with a link to a trusted source or a justification for the change request
  7. Thanks for the contribution - give yourself a celebratory pat on the back!

Review of the contribution

Each request will be reviewed by someone on the scientific reviewers team. The reviewers team will assess the contribution for scientific validity and, if appropriate, the change will be pushed to the live site!

Scientific Reviewers

All languages are needed here, but english will be needed for coordination. Domain expertise is key: public health, MD, virology, immunology, epidemiology, etc.

Your job here is to review updates and changes made by the community and confirm they are accurate and appropriate. If you have 30 minutes per day or more to help with this, please fill out our onboarding form

If you are profficient in a language other than English, your help with be great with translation verifications

Translators

We need to translate and adapt this content to as many languages as possible as soon as we can. Please check the instructions here.

Tech contributors

We're trying to grow this documentation as fast as we can. This website is based on Jekyll, so if you don't find what you need here, try taking a look at this tutorial: https://jekyllrb.com/docs/step-by-step/02-liquid/.

Running the project locally

  1. Clone the project.
  2. Run docker-compose up.
  3. In a browser, go to http://localhost:4000. The site should be running there.