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

create verifiability docs #229

Merged
merged 4 commits into from
Dec 20, 2022
Merged

Conversation

chenchanglew
Copy link
Contributor

create verifiability design docs.

@chenchanglew chenchanglew requested a review from a team as a code owner December 1, 2022 08:10
@coveralls
Copy link

coveralls commented Dec 1, 2022

Pull Request Test Coverage Report for Build 3705131688

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 56.783%

Totals Coverage Status
Change from base Build 3704930658: 0.0%
Covered Lines: 3273
Relevant Lines: 5764

💛 - Coveralls

@pierluca pierluca requested a review from si-co December 13, 2022 11:05
Copy link
Contributor

@nkcr nkcr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All good, just make sure to be consistent with the formatting. Especially, please leave exactly one blank line before and after titles and figures.

@chenchanglew chenchanglew force-pushed the feature/verifiability-design-doc branch from 1d4299e to 5f7c354 Compare December 14, 2022 15:06
Copy link
Contributor

@nkcr nkcr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The grammar of some sentences are sometimes a bit off, but overall we get the idea 👍 .

We just miss a reference to this document in the sidebar.md, which is the menu of the documentation website, after that we can merge.

@si-co
Copy link

si-co commented Dec 14, 2022

I had a partial look at the document. The content is very nice, but please fix formatting issues, try to keep short lines since is a markdown document, and fix spelling and grammar errors. If you're unsure about English I'm happy to discuss during one of our meetings.


## Introduction

Verifiability is an important property to allows voters to check their vote has been cast unaltered, and that it has been registered correctly in the electronic ballot box.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Verifiability is an important property to allows voters to check their vote has been cast unaltered, and that it has been registered correctly in the electronic ballot box.
Verifiability is an important property that enables a voter to check that their vote has been cast unaltered, and that it has been registered correctly in the electronic ballot box.


Verifiability is an important property to allows voters to check their vote has been cast unaltered, and that it has been registered correctly in the electronic ballot box.

The current d-voting (version num) didn't have this design yet. The current encrypted ballot logic is shown as follows:
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is (version num)? Before merging it would be nice to add it.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, avoid abbreviations such as didn't in formal documents.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is shown as follows is wrong, say either is as follows or is shown below, or something like that.

@chenchanglew chenchanglew requested a review from nkcr December 15, 2022 14:34
@chenchanglew chenchanglew force-pushed the feature/verifiability-design-doc branch from 1e3fae6 to 5ff682b Compare December 15, 2022 14:38
@chenchanglew chenchanglew force-pushed the feature/verifiability-design-doc branch from 5ff682b to 1869527 Compare December 15, 2022 14:41
@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

Copy link
Contributor

@nkcr nkcr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks 👍

@chenchanglew chenchanglew merged commit 1edd544 into main Dec 20, 2022
@chenchanglew chenchanglew deleted the feature/verifiability-design-doc branch December 20, 2022 22:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants