Election-Tech-Initiative / Election-Tech-Initiative/electionguard-python

✨ Serialized classes should include an ElectionGuard version

Aperta
#554 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
enhancement
Lingua principale
Python
Stelle
168
Fork
103
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

### Is there an existing issue for this?

- [X] 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_

Guida per i contributori

Apri la guida per i contributori

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.