Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document, improve schema modification workflow #767

Open
ivan-aksamentov opened this issue Jul 27, 2020 · 0 comments
Open

Document, improve schema modification workflow #767

ivan-aksamentov opened this issue Jul 27, 2020 · 0 comments
Labels
s:doc Scope: related to documentation t:feat Type: request of a new feature, functionality, enchancement

Comments

@ivan-aksamentov
Copy link
Member

ivan-aksamentov commented Jul 27, 2020

🙋 Feature Request

🔦 Context

The data flowing through application can sometimes change, depending on new scientific ideas and the epidemiological situation. We value backward compatibility with the old file and URL formats, but changing the data schema and adapting I/O serialization code for the new format has proven to be a difficult task. It requires many steps. Many I/O-related pieces of the application depends on it being done correctly.

😯 Describe the feature

We need to thoroughly document the steps that need to be taken in order to migrate the application to the new version of the schema.

Some basics can be found here:
#757 (comment)

The best place is probably in the readme, in (or after) the "Schemas" section
https://github.com/neherlab/covid19_scenarios/blob/9469b995be/README.md#schemas

We might also consider improving the entire workflow and reorganizing the code to make migrations more convenient and less error prone.

@ivan-aksamentov ivan-aksamentov added s:doc Scope: related to documentation t:feat Type: request of a new feature, functionality, enchancement labels Jul 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
s:doc Scope: related to documentation t:feat Type: request of a new feature, functionality, enchancement
Projects
None yet
Development

No branches or pull requests

1 participant