Skip to content
Snippets Groups Projects
Commit 559fb226 authored by Chandrasekhar Ramakrishnan's avatar Chandrasekhar Ramakrishnan
Browse files

docs: Added explanation and structure for contributions

parent 66a53954
No related branches found
No related tags found
No related merge requests found
...@@ -4,6 +4,10 @@ A Renku project for aggregating data from various covid-19 public data sources. ...@@ -4,6 +4,10 @@ A Renku project for aggregating data from various covid-19 public data sources.
See [Dashboard](covid-19-public-data/files/blob/runs/Dashboard.run.ipynb) for a summary of the data. See [Dashboard](covid-19-public-data/files/blob/runs/Dashboard.run.ipynb) for a summary of the data.
# Contributing
If you are interested in working on this project, we would love to get contributions. An easy contribution would be to add identifying and/or adding new data sources. See the section [Adding a new data source](#adding-a-new-data-source)
# Current Data Sources # Current Data Sources
## Covid-19 ## Covid-19
...@@ -19,4 +23,14 @@ See [Dashboard](covid-19-public-data/files/blob/runs/Dashboard.run.ipynb) for a ...@@ -19,4 +23,14 @@ See [Dashboard](covid-19-public-data/files/blob/runs/Dashboard.run.ipynb) for a
- https://github.com/COVID19Tracking/covid-19-crawler - https://github.com/COVID19Tracking/covid-19-crawler
- https://github.com/openZH/covid_19 - https://github.com/openZH/covid_19
- https://github.com/pcm-dpc/COVID-19 - https://github.com/pcm-dpc/COVID-19
\ No newline at end of file
## Adding a new data source
Adding a new data source is easy! To do so, in your fork or branch of the project, do the following:
* Create a renku dataset using `renku dataset create [dataset name]`
* Add any files or folders using `renku dataset add`. [Looking in the commit history will provide some examples](https://renkulab.io/gitlab/covid-19/covid-19-public-data/commits/master).
* Create a notebook that shows how to read and work with the dataset in the `notebooks/examples` folder
* Protip: use a unique name for the notebook to avoid merge conflicts
* Add an issue to the project for any suggestions on things to do with the data
# notebooks/examples
This is a place for example notebooks explaining how to work with particular data sources.
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment