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

Give concrete guidance on how to extend qlog #405

Open
rmarx opened this issue Mar 4, 2024 · 0 comments
Open

Give concrete guidance on how to extend qlog #405

rmarx opened this issue Mar 4, 2024 · 0 comments

Comments

@rmarx
Copy link
Contributor

rmarx commented Mar 4, 2024

With #417 and the additional-schema proposal, we're moving to a good state for qlog's extensibility.

However, we feel additional prose is needed to make people make good use of this extensibility. Without it, we will mainly have the proper CDDL structures and some scattered prose, but no clear flowcharts/lists or similar.

For example, we can add TODOs for different use cases:

  • If you want to add a fully new protocol, do xyz
  • If you want to add new fields to an existing event, do abc
  • If you want to add new options to an ENUM, do def

This can only be done after the extensibility stuff is properly done though, so this issue is to remind us later ;)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant