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.

Sign up for GitHub

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

Jump to bottom

docs: Add ADR for overall architecture, APIs, dependencies #32

Merged
merged 29 commits into from
Dec 19, 2023
Merged

docs: Add ADR for overall architecture, APIs, dependencies #32

merged 29 commits into from
Dec 19, 2023

Conversation

ancazamfir
Copy link
Collaborator

@ancazamfir ancazamfir commented Oct 27, 2023 •
edited by romac
Loading

Rendered

Started the arch ADR
Todo:

  • abstractions
  • clarify external dependencies especially:
    • how do we get value or do we rely on some external entity to send NewRound(r) vs NewRoundProposer(r, v)
    • who checks valid(v)? We pushed it out of the round SM, could be done in executor or we let the caller do it.
  • will sync with the code once we have fixed/ cleaned (should be in a few days)

@ancazamfir ancazamfir requested review from romac, cason and adizere October 27, 2023 19:10
@romac romac changed the title Add adr for overall architecture, APIs, dependencies docs: Add ADR for overall architecture, APIs, dependencies Oct 28, 2023
adizere
adizere reviewed Oct 28, 2023
View reviewed changes
Copy link
Member

@adizere adizere left a comment

Choose a reason for hiding this comment

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

Made a first pass with changes and left 2 comments.

Docs/architecture/adr-overall-architecture.md Outdated Show resolved Hide resolved
Docs/architecture/adr-overall-architecture.md Outdated Show resolved Hide resolved
@adizere adizere marked this pull request as ready for review October 28, 2023 15:37
@adizere adizere linked an issue Oct 28, 2023 that may be closed by this pull request
ADR 001: High level architecture of the implementation #33
Closed
@romac romac mentioned this pull request Nov 2, 2023
Merged
Base automatically changed from romac/rust-state-machine to main November 8, 2023 07:36
@romac romac force-pushed the anca/adr-overall-architecture branch from a7c9088 to c100d7f Compare November 8, 2023 07:38
@codecov Codecov
Copy link

codecov bot commented Nov 9, 2023 •
edited
Loading

Codecov upload limit reached ⚠️

This org is currently on the free Basic Plan; which includes 250 free private repo uploads each rolling month. This limit has been reached and additional reports cannot be generated. For unlimited uploads, upgrade to our pro plan.

Do you have questions or need help? Connect with our sales team today at sales@codecov.io

@ancazamfir ancazamfir merged commit 5db2ab0 into main Dec 19, 2023
9 checks passed
@ancazamfir ancazamfir deleted the anca/adr-overall-architecture branch December 19, 2023 10:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@adizere adizere adizere left review comments

@romac romac romac left review comments

@cason cason Awaiting requested review from cason

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

ADR 001: High level architecture of the implementation
3 participants
@ancazamfir @romac @adizere