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

Improve native format (.ga) schema #21

Open
6 tasks
davelopez opened this issue Apr 15, 2022 · 0 comments
Open
6 tasks

Improve native format (.ga) schema #21

davelopez opened this issue Apr 15, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@davelopez
Copy link
Owner

davelopez commented Apr 15, 2022

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

  • Document existing properties using the markdownDescription attribute.
  • Add missing properties
  • Add correct properties to required and leave out the optional ones
  • Fix incorrect type assignments to properties
  • Add default values or possible enum values to properties with known values
  • Add defaultSnippets where auto-completion can be beneficial
@davelopez davelopez added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels Apr 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Development

No branches or pull requests

1 participant