Skip to content

✨ Serialized classes should include an ElectionGuard version #554

Open

Description

@keithrfung

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions