Skip to content

Gov vote flow #624

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

Merged
merged 4 commits into from
Apr 4, 2024
Merged

Conversation

Relequestual
Copy link
Member

@Relequestual Relequestual commented Feb 13, 2024

GitHub Issue: NA
Related to #423

Summary: Keeping the governance process loaded in memory might be tricky as we get used to using it. This PR adds a Finite State Machine for the voting process. A visual and executable version of the voting process should help in its understanding.

Do you think resolving this issue might require an Architectural Decision Record (ADR)? (significant or noteworthy)
No

To preview the Mermaid diagram in this PR, click the dots (...) in the top right of the file, then "View File".

@Relequestual Relequestual requested a review from benjagm February 13, 2024 14:19
votingMachine.Idle --> votingMachine.Awaiting_approval_for_private_vote : Request private vote \ndo / Contact TSC Chairs
votingMachine.Awaiting_approval_for_private_vote --> votingMachine.Awaiting_additional_comment_for_counting_votes : Create Issue in private repo\nif [TSC Chair approved]
votingMachine.Voting_open --> votingMachine.Awaiting_extension_approval : request_extension \ndo / requestExtension
votingMachine.Voting_open --> votingMachine.VotingClosed : xstate.after(604800000)#votingMachine.Voting open \ndo / calculateQuorum
Copy link
Member

Choose a reason for hiding this comment

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

This is rendering weird:

image

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah, unfortunatly it doesn't seem like I can do much about that.
I think what's more important is the flow and what happens in what order.

Copy link
Member

@gregsdennis gregsdennis left a comment

Choose a reason for hiding this comment

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

This seems like a lot for "how does voting work?"

@gregsdennis
Copy link
Member

gregsdennis commented Feb 13, 2024

To preview the Mermaid diagram in this PR, click the dots (...) in the top right of the file, then "View File".

You can also just look at the markdown view in the file diff.
image

Copy link
Collaborator

@benjagm benjagm left a comment

Choose a reason for hiding this comment

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

Thanks a lot for this Ben. It will help a lot to folks like me.

@Relequestual Relequestual merged commit b8c6a9e into json-schema-org:main Apr 4, 2024
@Relequestual Relequestual deleted the gov-vote-flow branch April 4, 2024 10:16
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.

3 participants