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

✨ Serialized classes should include an ElectionGuard version #554

Open
1 task done
keithrfung opened this issue Feb 28, 2022 · 0 comments
Open
1 task done

✨ Serialized classes should include an ElectionGuard version #554

keithrfung opened this issue Feb 28, 2022 · 0 comments
Labels
enhancement New feature or request

Comments

@keithrfung
Copy link
Collaborator

keithrfung commented Feb 28, 2022

Is there an existing issue for this?

  • I have searched the existing issues

Suggestion

Serialized classes should include a version number that indicates what version is currently being used. Currently, the team is working towards 1.0 for the next release so the version would be 1.0.

This would overwrite the field that is currently on the manifest indicating the specification version. The expectation is a field on each section called electionguard_version: "1.0"

Possible names
electionguard_version
eg_version
eg_ver
sdk_version

Possible Implementation

This could be done by adding a field to existing models but should likely be restricted to certain classes. The primary concern are those files in the Election Record exclusively.

Existing one to be changed.
https://github.com/microsoft/electionguard-python/blob/c59fddcd89f85619ba801d6c38b1ea7f08210951/src/electionguard/manifest.py#L583

Anything else?

No response

@keithrfung keithrfung added the enhancement New feature or request label Feb 28, 2022
@keithrfung keithrfung added this to the 🔥 🦖 Bowser v1.4.0 milestone Feb 28, 2022
@keithrfung keithrfung removed this from the 🔥 🦖 Bowser v1.4.0 milestone May 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant