Contributing

Onboarding

Thanks for your interest in time series forecasting at CoronaWhy. If you are interested in contributing to our team at CoronaWhy you should first do the following:

1. Review the basic information page of our Wiki
2. Review our Trello board for tasks you might be able to help.
3. Skim through our most recent meetings.
4. PM the team lead on Slack (or if you are not currently on the CoronaWhy Slack send the lead an email) with what tasks you think you could help with and your approximate weekly time commitment.
5. Please try to attend meetings and/or communicate your progress on issues via Slack, Trello, or GitHub.

Contributing Code

1. All code requires at least one approving review.
2. Non-notebook code must have unit tests and pass all unit/integration tests.
3. Code should include type hints and comply with Flake 8.
4. Model contributions should all go into the core repo.

Filing issues

1. Before opening an issue please use the search feature to check there is not an existing issue.
2. Properly label the issue as bug, enhancement, or feature request.
3. Include clear details to reproduce the issue (OS, Cloud v.s. local)

Accessing Data

1. Data available to the public is hosted on Dataverse.
2. Data that requires signing a MUOC is hosted on GCP.