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.

Sign up for GitHub

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

fix: updates to opensource and definitions #1519

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
+156 −151
Open

fix: updates to opensource and definitions #1519

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
01c263d
fix: schema updates, opensource and definitions
nathanbogale Jan 14, 2025
be491b5
Merge branch 'main' into fix/proposal-remplate
stevenj Jan 15, 2025
2728bea
fix: changelog on proposal template, and other optional fixes
nathanbogale Jan 15, 2025
c7ba331
Update docs/src/architecture/08_concepts/document_templates/proposal/…
nathanbogale Jan 16, 2025
b401a2a
fix: enforced https
nathanbogale Jan 16, 2025
dd74ada
Merge branch 'main' into fix/proposal-remplate
stevenj Jan 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 20 additions & 17 deletions .../document_templates/proposal/F14-Generic/0ce8ab38-9258-4fbc-a62e-7faa6e58318f.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@
"$id": "https://cardano.org/schemas/catalyst/f14/proposal",
"title": "F14 Submission Form",
"description": "Schema for the F14 Catalyst Proposal Submission Form",
"version": "1.0.0",
"lastUpdated": "2025-01-14",
"maintainers": ["Cardano Foundation"],
"changelog": {
"1.0.0": "Initial version"
},
stevenj marked this conversation as resolved.
Show resolved Hide resolved
"definitions": {
"schemaReferenceNonUI": {
"$comment": "NOT UI: used to identify the kind of template document used.",
Expand Down Expand Up @@ -33,8 +39,8 @@
"$comment": "UI - Single Line text entry for HTTPS Urls.",
"type": "string",
"format": "uri",
"pattern": "^https:.*",
"x-note": "Enter a valid HTTPS URL. Must start with 'https://' and be a complete, working web address."
"pattern": "^[^\\n\\r]*$",
stevenj marked this conversation as resolved.
Show resolved Hide resolved
"x-note": "Must start with 'https://' and is followed by one or more non-whitespace characters, ending at the end of the string."
},
"multiLineTextEntry": {
"$comment": "UI - Multiline text entry without any markup or rich text capability.",
Expand Down Expand Up @@ -498,28 +504,25 @@
"description": "Will your project's output be fully open source? Open source refers to something people can modify and share because its design is publicly accessible.",
"x-guidance": "Open source software is software with source code that anyone can inspect, modify, and enhance. Conversely, only the original authors of proprietary software can legally copy, inspect, and alter that software",
"properties": {
"source_code": {
"$ref": "#/definitions/spdxLicenseOrURL"
},
"documentation": {
"$ref": "#/definitions/spdxLicenseOrURL"
"isOpenSource": {
"$ref": "#/definitions/yesNoChoice",
"title": "Is the project open source?",
"description": "Select Yes if the project is open source, No if it is not."
},
"note": {
"licenseInformation": {
"$ref": "#/definitions/multiLineTextEntry",
"title": "More Information",
"description": "Please provide here more information on the open source status of your project outputs",
"maxLength": 500,
"x-guidance": "<p>If you did not answer PROPRIETARY to the above questions, the project should be open source available throughout the entire lifecycle of the project with a declared open-source repository. Please indicate here the type of license you intend to use for open source and provide any further information you feel is relevant to the open source status of your project outputs If only certain elements of your code will be open source please clarify which elements will be open source here. If you answered NO to the above question, please give further details as to why your projects outputs will not be open source METADATA</p>"
"title": "License and Additional Information",
"description": "Provide the license type and any additional context regarding the open-source status of your project. If partially open source, specify which parts are open source.",
"maxLength": 500
}
},
"required": [
"source_code",
"documentation"
"isOpenSource",
"licenseInformation"
],
"x-order": [
"source_code",
"documentation",
"note"
"isOpenSource",
"licenseInformation"
]
}
},
Expand Down
267 changes: 133 additions & 134 deletions ...rc/architecture/08_concepts/document_templates/proposal/F14-Generic/example.proposal.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,135 +1,134 @@
{
"$schema": "./0ce8ab38-9258-4fbc-a62e-7faa6e58318f.schema.json",
"setup": {
"title": {
"title": "Example Catalyst Proposal"
},
"proposer": {
"applicant": "John Smith",
"type": "Individual",
"coproposers": [
"Jane Doe",
"Bob Wilson"
]
}
},
"summary": {
"budget": {
"requestedFunds": 150000
},
"time": {
"duration": 6
},
"translation": {
"isTranslated": true,
"originalLanguage": "de",
"originalDocumentLink": "https://example.com/original-doc"
},
"problem": {
"statement": "Current challenge in the Cardano ecosystem...",
"impact": [
"Technical Infrastructure",
"Developer Tooling",
"Adoption"
]
},
"solution": {
"summary": "Our solution provides a comprehensive toolkit...",
"approach": "We will implement this solution using...",
"innovationAspects": [
"Novel testing framework",
"Automated integration tools"
]
},
"supportingLinks": {
"mainRepository": "https://github.com/example/project",
"documentation": "https://docs.example.com",
"other": [
"https://example.com/whitepaper",
"https://example.com/roadmap"
]
},
"dependencies": {
"details": [{
"name": "External API Service",
"type": "Technical",
"description": "Integration with third-party API service",
"mitigationPlan": "Build fallback mechanisms and maintain alternative providers"
}]
},
"open_source": {
"source_code": "MIT",
"documentation": "MIT",
"note": "All project outputs will be open source under MIT license"
}
},
"horizons": {
"theme": {
"grouped_tag": {
"group": "DeFi",
"tag": "Staking"
}
}
},
"details": {
"solution": {
"solution": "Our solution involves developing a comprehensive toolkit that will enhance the Cardano developer experience..."
},
"impact": {
"impact": "The project will significantly impact developer productivity by reducing development time and improving code quality..."
},
"feasibility": {
"feasibility": "Our team has extensive experience in blockchain development and has successfully delivered similar projects..."
}
},
"milestones": {
"milestones": {
"milestone_list": [{
"title": "Initial Setup and Planning",
"outputs": "Project infrastructure setup and detailed planning documents",
"acceptance_criteria": "- Development environment configured\n- Detailed project plan approved",
"evidence": "- GitHub repository setup\n- Documentation of infrastructure\n- Project planning documents",
"delivery_month": 1,
"cost": 30000,
"progress": "Not Started"
},
{
"title": "Core Development",
"outputs": "Implementation of main features",
"acceptance_criteria": "- Core features implemented\n- Unit tests passing",
"evidence": "- Code repository\n- Test results\n- Technical documentation",
"delivery_month": 3,
"cost": 60000,
"progress": "Not Started"
},
{
"title": "Final Release and Documentation",
"outputs": "Project completion, documentation, and Project Close-out Report and Video",
"acceptance_criteria": "- All features implemented and tested\n- Documentation complete\n- Close-out report and video delivered",
"evidence": "- Final release\n- Complete documentation\n- Close-out report and video",
"delivery_month": 6,
"cost": 60000,
"progress": "Not Started"
}
]
}
},
"pitch": {
"team": {
"who": "Our team consists of experienced blockchain developers with proven track records..."
},
"budget": {
"costs": "Budget breakdown:\n- Development (70%): 105,000 ADA\n- Testing (15%): 22,500 ADA\n- Documentation (15%): 22,500 ADA"
},
"value": {
"note": "This project provides excellent value for money by delivering essential developer tools..."
}
},
"agreements": {
"mandatory": {
"fund_rules": true,
"terms_and_conditions": true,
"privacy_policy": true
}
}
{
"$schema": "./0ce8ab38-9258-4fbc-a62e-7faa6e58318f.schema.json",
"setup": {
"title": {
"title": "Example Catalyst Proposal"
},
"proposer": {
"applicant": "John Smith",
"type": "Individual",
"coproposers": [
"Jane Doe",
"Bob Wilson"
]
}
},
"summary": {
"budget": {
"requestedFunds": 150000
},
"time": {
"duration": 6
},
"translation": {
"isTranslated": true,
"originalLanguage": "de",
"originalDocumentLink": "https://example.com/original-doc"
},
"problem": {
"statement": "Current challenge in the Cardano ecosystem...",
"impact": [
"Technical Infrastructure",
"Developer Tooling",
"Adoption"
]
},
"solution": {
"summary": "Our solution provides a comprehensive toolkit...",
"approach": "We will implement this solution using...",
"innovationAspects": [
"Novel testing framework",
"Automated integration tools"
]
},
"supportingLinks": {
"mainRepository": "https://github.com/example/project",
"documentation": "https://docs.example.com",
"other": [
"https://example.com/whitepaper",
"https://example.com/roadmap"
]
},
"dependencies": {
"details": [{
"name": "External API Service",
"type": "Technical",
"description": "Integration with third-party API service",
"mitigationPlan": "Build fallback mechanisms and maintain alternative providers"
}]
},
"open_source": {
"isOpenSource": true,
"licenseInformation": "All source code and documentation will be released under the MIT license."
}
},
"horizons": {
"theme": {
"grouped_tag": {
"group": "DeFi",
"tag": "Staking"
}
}
},
"details": {
"solution": {
"solution": "Our solution involves developing a comprehensive toolkit that will enhance the Cardano developer experience..."
},
"impact": {
"impact": "The project will significantly impact developer productivity by reducing development time and improving code quality..."
},
"feasibility": {
"feasibility": "Our team has extensive experience in blockchain development and has successfully delivered similar projects..."
}
},
"milestones": {
"milestones": {
"milestone_list": [{
"title": "Initial Setup and Planning",
"outputs": "Project infrastructure setup and detailed planning documents",
"acceptance_criteria": "- Development environment configured\n- Detailed project plan approved",
"evidence": "- GitHub repository setup\n- Documentation of infrastructure\n- Project planning documents",
"delivery_month": 1,
"cost": 30000,
"progress": "Not Started"
},
{
"title": "Core Development",
"outputs": "Implementation of main features",
"acceptance_criteria": "- Core features implemented\n- Unit tests passing",
"evidence": "- Code repository\n- Test results\n- Technical documentation",
"delivery_month": 3,
"cost": 60000,
"progress": "Not Started"
},
{
"title": "Final Release and Documentation",
"outputs": "Project completion, documentation, and Project Close-out Report and Video",
"acceptance_criteria": "- All features implemented and tested\n- Documentation complete\n- Close-out report and video delivered",
"evidence": "- Final release\n- Complete documentation\n- Close-out report and video",
"delivery_month": 6,
"cost": 60000,
"progress": "Not Started"
}
]
}
},
"pitch": {
"team": {
"who": "Our team consists of experienced blockchain developers with proven track records..."
},
"budget": {
"costs": "Budget breakdown:\n- Development (70%): 105,000 ADA\n- Testing (15%): 22,500 ADA\n- Documentation (15%): 22,500 ADA"
},
"value": {
"note": "This project provides excellent value for money by delivering essential developer tools..."
}
},
"agreements": {
"mandatory": {
"fund_rules": true,
"terms_and_conditions": true,
"privacy_policy": true
}
}
}
Loading