-
Notifications
You must be signed in to change notification settings - Fork 8
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(docs): proposal template drafting #1330
base: main
Are you sure you want to change the base?
Conversation
✅ Test Report | |
✅ Test Report | |
✅ Test Report | |
✅ Test Report | |
✅ Test Report | |
…tput-hk/catalyst-voices into feat/proposal-template-drafting
✅ Test Report | |
✅ Test Report | |
✅ Test Report | |
✅ Test Report | |
✅ Test Report | |
…tput-hk/catalyst-voices into feat/proposal-template-drafting
✅ Test Report | |
✅ Test Report | |
✅ Test Report | |
✅ Test Report | |
I'd like to suggest using Instead of relying on object property order (which is not guaranteed by the specification), we can add {
"properties": {
"setup": {
"properties": {
"title": { ... },
"proposer": { ... }
},
"x-order": ["title", "proposer"]
}
},
"x-order": ["setup", "summary", "horizons", "details", "milestones", "pitch", "agreements"]
} Benefits:
Some additional details about implementing the
{
"x-order": ["setup", "summary", "horizons", "details", "milestones", "pitch", "agreements"],
"properties": { ... }
}
{
"setup": {
"x-order": ["title", "proposer"],
"properties": {
"title": { ... },
"proposer": { ... }
}
}
}
{
"proposer": {
"x-order": ["applicant", "type", "coproposers"],
"properties": {
"applicant": { ... },
"type": { ... },
"coproposers": { ... }
}
}
}
{
"summary": {
"x-order": [
"budget",
"time",
"translation",
"problem",
"solution",
"supportingLinks",
"dependencies",
"open_source"
],
"properties": {
"budget": {
"x-order": ["requestedFunds"],
"properties": { ... }
},
"time": {
"x-order": ["duration"],
"properties": { ... }
}
}
}
}
{
"dependencies": {
"details": {
"items": {
"x-order": ["name", "type", "description", "mitigationPlan"],
"properties": { ... }
}
}
}
}
{
"translation": {
"x-order": ["isTranslated", "originalLanguage", "translationNotes"],
"properties": { ... },
"dependencies": {
"originalLanguage": ["isTranslated"],
"translationNotes": ["isTranslated"]
}
}
}
|
"default": [], | ||
"items": { | ||
"$ref": "#/definitions/multiLineTextEntryMarkdown", | ||
"maxLength": 10240 |
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.
should this be 1024?
"items": { | ||
"$ref": "#/definitions/singleLineHttpsURLEntry", | ||
"maxLength": 1024 | ||
} |
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.
how this items object is working?
✅ Test Report | |
✅ Test Report | |
"$schema": "http://json-schema.org/draft-07/schema#", | ||
"title": "Catalyst Fund 14 Base Proposal Template", | ||
"description": "A structured template for creating Fund 14 proposals", | ||
"definitions": { |
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.
JsonSchema has structuring tags one of which is $def, should that be used instead of "definitions" for the purpose of defining reusable structures
https://json-schema.org/understanding-json-schema/structuring#defs
✅ Test Report | |
✅ Test Report | |
✅ Test Report | |
Description
Thanks for contributing to the project!
Please fill out this template to help us review your changes.
Related Issue(s)
List the issue numbers related to this pull request.
Description of Changes
Provide a clear and concise description of what the pull request changes.
Breaking Changes
Describe any breaking changes and the impact.
Screenshots
If applicable, add screenshots to help explain your changes.
Related Pull Requests
If applicable, list any related pull requests.
Please confirm the following checks