Skip to content

fix: f14 proposal schema restructuring #2230

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

Open
wants to merge 33 commits into
base: main
Choose a base branch
from

Conversation

nathanbogale
Copy link
Contributor

@nathanbogale nathanbogale commented Apr 9, 2025

Description

F14 Catalyst Submission Form Schema Restructuring

Overview

This pull request restructures the JSON schema for the F14 Catalyst Submission Form to enhance the form organization, improve user experience, and ensure consistency across the submission process.

Changes

Reorganized segments to follow the new order: schemaReference, Setup, Selected Category, Summary, Project Details, Milestones, Funding Justification, and Acknowledgements
Added comprehensive x-order specifications for all segments, sections, and field groups to ensure consistent UI rendering
Added detailed user guidance (x-guidance) and placeholders (x-placeholder) for all form fields to improve user experience
Moved 'theme', 'translation', and 'open source' sections into the setup segment
Moved 'selected category' to its own top-level segment
Changed category acknowledgements from radio buttons to checkboxes
Moved category-specific acknowledgements into the main acknowledgements segment
Removed references to "proposal" for clarity and consistency
Enhanced validation rules for fields with minimum/maximum value constraints
Added detailed milestone guidance for all milestone sections

Breaking Changes

Renamed several sections, and changed structures

Checks

  • 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
  • The schema has been validated for proper JSON syntax
  • Segment and section structures have been verified for completeness
  • Field validation rules have been checked for accuracy

@nathanbogale nathanbogale self-assigned this Apr 9, 2025
@nathanbogale nathanbogale moved this from New to 👀 In review in Catalyst Apr 9, 2025
@nathanbogale nathanbogale changed the title F14 Catalyst Form Schema Restructuring fix: f14 proposal schema restructuring Apr 9, 2025
Copy link
Contributor

github-actions bot commented Apr 9, 2025

Test Report | ${\color{lightgreen}Pass: 686/699}$ | ${\color{red}Fail: 8/699}$ |

neil-iohk
neil-iohk previously approved these changes Apr 15, 2025
Copy link
Contributor

@neil-iohk neil-iohk left a comment

Choose a reason for hiding this comment

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

Verified changes and suggested change pre merge

@minikin
Copy link
Collaborator

minikin commented Apr 16, 2025

This PR should not be merged without @dtscalac's approval.

Copy link
Contributor

@dtscalac dtscalac left a comment

Choose a reason for hiding this comment

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

The PR needs to wait until #2298 is merged and the tests run on the changes from here.

@github-project-automation github-project-automation bot moved this from 👀 In review to 🔖 Ready in Catalyst Apr 16, 2025
minikin and others added 3 commits April 16, 2025 14:11
# Conflicts:
#	docs/src/architecture/08_concepts/document_templates/proposal/F14-Generic/example.proposal.json
@nathanbogale nathanbogale force-pushed the proposal-improvements branch from 4ec812a to ddd097e Compare May 10, 2025 12:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
do not merge yet PR is not ready to be merged yet F14
Projects
Status: 🔖 Ready
Development

Successfully merging this pull request may close these issues.

5 participants