-
Notifications
You must be signed in to change notification settings - Fork 89
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
docs: Update Draft TRG 1-4 #429
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@FaGru3n to be honest i am not sure if a change is needed :)
We need to clarify this TRG a little bit more: Generally speaking i don't think its enough to just have a *.svg file available because, while you can change it (its plain text) without knowhing which tool you used to generate it, you can't really change it. You can fix existing text, you might be able to update some lines etc. but not 'change' the content. We might even make it mandatory to have a short section in the README.md to clarify which tool they use. draw.io for example is a good option but if you need a speicifc version you might need to document how to use it with something like a container image we host ourselfes and we need to align on a version. |
@Siegfriedk not sure if this helps, but at least in the SVG file which were created by draw.io there is always this note in the header |
outdated branch that was checked
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM Thank you
I will wait for @Siegfriedk for the approval before merge 😉 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think if we want to restrict contributors to specific tools, then we need to provide more guidance.
Alternative would be only mention the tools as valid options (golden path) and only have mandatory guidelines, like:
- You need to contribute the "raw" editable source
- Used tools need to be usable by anyone without the need of a licence or similar (prefer open source tools)
- Tools should be OS independent
and so on
updated my branch current view: |
Description
fixes #427
ongoing IP-Validation Checks
Preview
Pre-review checks
Please ensure to do as many of the following checks as possible, before asking for committer review: