Add a guideline for Example creation to the developer doc#73
Merged
chrizmc merged 1 commit intoCOVESA:mainfrom Mar 26, 2025
Merged
Add a guideline for Example creation to the developer doc#73chrizmc merged 1 commit intoCOVESA:mainfrom
chrizmc merged 1 commit intoCOVESA:mainfrom
Conversation
Use the Knowledge and Information Layer Example proposal posted by Christian Muhlbauer (created with his colleagues at BMW) to Slack as the basis for an initial guideline for the creation of new Examples. Also link to it in the list of best practises. Signed-off-by: Stephen Lawrence <stephen.lawrence@renesas.com>
slawr
added
documentation
chrizmc
approved these changes
Mar 25, 2025
Collaborator
chrizmc
left a comment
chrizmc
left a comment
There was a problem hiding this comment.
Looks good from my side. Could be that we have to adapt it a bit after the Knowledge Layer PR is merged because we have planned to simplify few things even further in the config directory
Collaborator
Author
|
Thanks for the review and yes we can adjust as we go. As a starting point I deliberately made it a SHOULD guideline, rather than a SHALL harder requirement when linking to it from the best practices. |
github-project-automation
bot
moved this from In Progress
to Done
in Central Data Service Playground
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Use the Knowledge and Information Layer Example proposal posted by Christian Muhlbauer (created with his colleagues at BMW) to Slack as the basis for an initial guideline for the creation of new Examples. Also link to it in the list of best practises.
@chrizmc as discussed in the Data Arch call I converted your proposal to markdown and added it as an Example guideline. Please take a look and give feedback