-
Notifications
You must be signed in to change notification settings - Fork 285
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
docs(copm): Add sequence diagrams for COPM primitives #3716
base: main
Are you sure you want to change the base?
docs(copm): Add sequence diagrams for COPM primitives #3716
Conversation
@jenniferlianne interesting to know that we can use a plugin to render the sequence diagrams in the readme itself! @petermetz shall this be moved to docs/architecture folder just like other packages and then referenced in the base Readme file? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great, I'm ok with both keeping these diagrams here or moving them to docs as suggested by Jagpreet. I found one small typo though
packages/cacti-copm-core/README.md
Outdated
- Lock | ||
- ClaimLock | ||
|
||
### Figure: Asset Exchange with Lock and ClamLock |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo - should be ClaimLock
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you.
c14afa3
to
c1b0ddd
Compare
Primary change: adds mermaid sequence diagrams for how COPM primitives are used in asset transfer, asset exchange, and data sharing to copm-core README Secondary change: adds TOC and reformats raw urls to links Signed-off-by: Jennifer Bell <jenniferlianne@gmail.com>
c1b0ddd
to
1f75a30
Compare
Primary change: adds mermaid sequence diagrams for how COPM primitives are used in asset transfer, asset exchange, and data sharing to copm-core README
Secondary change: adds TOC and reformats urls to links.
Pull Request Requirements
upstream/main
branch and squashed into single commit to help maintainers review it more efficient and to avoid spaghetti git commit graphs that obfuscate which commit did exactly what change, when and, why.-s
flag when usinggit commit
command. You may refer to this link for more information.Character Limit
A Must Read for Beginners
For rebasing and squashing, here's a must read guide for beginners.