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

Rename the "examples" folder so that it's clear it's for validation purposes #217

Closed
2 tasks
afrittoli opened this issue May 10, 2024 · 0 comments · Fixed by #226
Closed
2 tasks

Rename the "examples" folder so that it's clear it's for validation purposes #217

afrittoli opened this issue May 10, 2024 · 0 comments · Fixed by #226
Assignees
Milestone

Comments

@afrittoli
Copy link
Contributor

The "example" folders contains example of CDEvents, which are designed with the goal of verifying schemas and doing conformance testing for SDKs, rather than being real-life examples for users to adopt.

We should:

  • rename examples to "conformance"
  • include a README.md in the folder that explains what they are and how they are used

Additionally, as separate issues, we should

  • Add a checkbox in the GitHub PR template about updating conformance when updating the schema
  • Add a CI check that figures out if conformance was not updated when it should have been
  • Update the SDKs to use the conformance folder instead of examples. This can be done as part of the v0.4.x SDK updates
@afrittoli afrittoli added this to the v0.4 milestone May 10, 2024
@afrittoli afrittoli self-assigned this May 10, 2024
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

Successfully merging a pull request may close this issue.

1 participant