Skip to content

Contributing

Thank you for your interest in contributing to the US Disease Tracker project! This document provides guidelines for contributing data on reportable diseases from public health jurisdictions, reporting errors or issues, and proposing new data standards.

Code of Conduct

By participating in this project, you agree to maintain a respectful and collaborative environment.

How to Contribute

Contributing disease data

To contribute data as a jurisdiction:

  1. Review the current data standards and template
  2. Format your data to match the data structure provided in examples-and-templates/
  3. Contact the project team to register users and schedule an onboarding meeting (coming soon!)

Reporting Issues

If you find an error in the documentation or have a suggestion:

  1. Check if the issue already exists in GitHub Issues
  2. If not, create a new issue with a clear title and description
  3. Include relevant examples or references

Proposing New or Modified Data Standards

To propose a new data standard or a modification to an existing one:

  1. Open an issue describing the proposed standard
  2. Discuss the scope and requirements
  3. Include relevant examples, reasoning, and need for the change

The project team will review the proposed standard or modification. Depending on the scope of the standard and the changes required, the project team will respond or take the change to the advisory groups for further discussion.

Standard Requirements

All proposed new data standards or modifications must include:

  • [ ] At least one example
  • [ ] Clear field definitions with data types
  • [ ] Validation rules

License

By contributing, you agree that your contributions will be licensed under the GNU General Public License v3.0 or later.

Thank you for contributing to US Disease Tracker!