-
Notifications
You must be signed in to change notification settings - Fork 4
Improve native format (.ga) schema #21
Copy link
Copy link
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is needed
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is needed
Projects
Status
Todo
With #18, #19, and #20, we can now get a great deal of functionality out of the native .ga format schema definition but the schema is largely incomplete and inaccurate (initial version generated by an existing sample workflow).
How to improve it
The schema is easy to extend and improve, in addition to the standard JSON schema properties defined in the documentation, we can use some custom properties supported in VSCode to use Markdown formatting in hovers or insert snippets.
Parts that need improving
markdownDescriptionattribute.requiredand leave out the optional onesdefaultvalues or possibleenumvalues to properties with known valuesdefaultSnippetswhere auto-completion can be beneficial