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

feat: added design doc template and short instructions #551

Merged
merged 4 commits into from
Jan 28, 2025

Conversation

mattp-swirldslabs
Copy link
Contributor

Description:

  • Added a short set of steps and a template markdown

Related issue(s):

Fixes #550

Notes for reviewer:

Checklist

  • Documented (Code comments, README, etc.)

Sorry, something went wrong.

Signed-off-by: Matt Peterson <[email protected]>
@mattp-swirldslabs mattp-swirldslabs self-assigned this Jan 28, 2025
@mattp-swirldslabs mattp-swirldslabs marked this pull request as ready for review January 28, 2025 17:05
@mattp-swirldslabs mattp-swirldslabs requested a review from a team as a code owner January 28, 2025 17:05
@mattp-swirldslabs mattp-swirldslabs changed the title added design doc template and short instructions feat: added design doc template and short instructions Jan 28, 2025
@mattp-swirldslabs mattp-swirldslabs added this to the 0.4.0 milestone Jan 28, 2025
@mattp-swirldslabs mattp-swirldslabs added Design Issue/PR for feature design documents Block Node Issues/PR related to the Block Node. labels Jan 28, 2025
Copy link
Contributor

@jsync-swirlds jsync-swirlds left a comment

Choose a reason for hiding this comment

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

This looks good; a couple suggestions that might make things a little more user friendly.

mattp-swirldslabs and others added 2 commits January 28, 2025 12:39
Signed-off-by: Matt Peterson <[email protected]>
Co-authored-by: Joseph S. <[email protected]>
Signed-off-by: Matt Peterson <[email protected]>
Co-authored-by: Joseph S. <[email protected]>
Signed-off-by: Matt Peterson <[email protected]>
Copy link
Contributor

@jsync-swirlds jsync-swirlds left a comment

Choose a reason for hiding this comment

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

LGTM.

Copy link
Contributor

@AlfredoG87 AlfredoG87 left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@mattp-swirldslabs mattp-swirldslabs merged commit dfe4690 into main Jan 28, 2025
17 checks passed
@mattp-swirldslabs mattp-swirldslabs deleted the 00550-design-doc-template branch January 28, 2025 20:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Block Node Issues/PR related to the Block Node. Design Issue/PR for feature design documents
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Design doc template and example
3 participants