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(cat-voices): f14-Comments Schema for Catalyst Proposals #1731

Merged
merged 5 commits into from
Feb 4, 2025

Conversation

nathanbogale
Copy link
Contributor

Description

This PR introduces the F14-Comments schema used for comments on Catalyst proposals.

Changes:

  • Schema Definition: Added a new JSON schema for proposal comments, ensuring compliance with draft-07 standards.
  • UUID Field: Defined a UUID field type for unique identification of comments and their parent entities.
  • Multi-Line Text Entry: Introduced a multi-line text entry definition to support plain text comments with line breaks, without markup or rich text.
  • Metadata Requirements: Specified required fields within the metadata, including id, parent_id, and proposal_id, all adhering to the UUID format.
  • Comment Content: Defined the comment content with constraints on text length, ensuring a minimum of 1 and a maximum of 5000 characters.

Created example.comment.json with a complete example following the schema
The example serves as a reference for developers and users to understand the expected format of comments in the Catalyst Voices system.

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream module

@nathanbogale nathanbogale added review me PR is ready for review comment me Request for comments F14 labels Jan 29, 2025
@nathanbogale nathanbogale added this to the M4: Voting & Delegation milestone Jan 29, 2025
@nathanbogale nathanbogale self-assigned this Jan 29, 2025
@nathanbogale nathanbogale changed the title fafeat(cat-voices): f14-Comments Schema for Catalyst Proposals feat(cat-voices): f14-Comments Schema for Catalyst Proposals Jan 29, 2025
Copy link
Contributor

Test Report | ${\color{lightgreen}Pass: 449/449}$ | ${\color{red}Fail: 0/449}$ |

Copy link
Contributor

Test Report | ${\color{lightgreen}Pass: 455/455}$ | ${\color{red}Fail: 0/455}$ |

Copy link
Contributor

Test Report | ${\color{lightgreen}Pass: 455/455}$ | ${\color{red}Fail: 0/455}$ |

Copy link
Collaborator

@stevenj stevenj left a comment

Choose a reason for hiding this comment

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

LGTM

@stevenj stevenj enabled auto-merge (squash) February 4, 2025 14:57
@stevenj stevenj merged commit d10ea59 into main Feb 4, 2025
38 checks passed
@stevenj stevenj deleted the feat/proposal-comments branch February 4, 2025 15:11
Copy link
Contributor

github-actions bot commented Feb 4, 2025

Test Report | ${\color{lightgreen}Pass: 467/467}$ | ${\color{red}Fail: 0/467}$ |

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
comment me Request for comments F14 review me PR is ready for review
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants