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

docs: add TRG for UX/UI styleguide #865

Merged
merged 5 commits into from
Jul 25, 2024
Merged

Conversation

jjeroch
Copy link
Contributor

@jjeroch jjeroch commented Apr 28, 2024

Description

add TRG for UX/UI styleguide

Pre-review checks

@jjeroch jjeroch requested review from kelaja and RolaH1t April 28, 2024 18:08
@jjeroch jjeroch added the documentation Improvements or additions to documentation label Apr 28, 2024
Copy link
Contributor

@FaGru3n FaGru3n left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @jjeroch thanks for the work,

i personally would leave out the checkbox style within the TRG but would take it as a little tasklist for the Release guideline checks... or implement this within our PR template.

Then within the TRG it is clear what to consider is a must or be aware of the styleguide.

Copy link

@RolaH1t RolaH1t left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Quality or Release Gateways are not confirmed for the future process; I therefore propose some wording updates to enable the check of the UI/UX criteria upon releasing a new GitHub version of any app with user interface

@evegufy evegufy changed the title docs: add release gateway criterias UX/UI docs: add TRG for UX/UI styleguide Jul 22, 2024
@evegufy evegufy requested review from RolaH1t, FaGru3n, matbmoser, tom-rm-meyer-ISST, a team and MaximilianHauer and removed request for kelaja July 22, 2024 19:00
Copy link
Contributor

@tom-rm-meyer-ISST tom-rm-meyer-ISST left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for providing! The TRG often refers to a styleguide for which I'm not sure which link actually must be handled as. For more explanations, please refer to the comments.

docs/release/trg-9/trg-9-01.md Outdated Show resolved Hide resolved
docs/release/trg-9/trg-9-01.md Outdated Show resolved Hide resolved
Copy link
Contributor

@tom-rm-meyer-ISST tom-rm-meyer-ISST left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, reframing makes it more understandable!

docs/release/trg-9/trg-9-01.md Show resolved Hide resolved
docs/release/trg-9/trg-9-01.md Show resolved Hide resolved
docs/release/trg-9/trg-9-01.md Show resolved Hide resolved
docs/release/trg-9/trg-9-01.md Show resolved Hide resolved
@matbmoser matbmoser self-requested a review July 23, 2024 13:34
Copy link
Contributor

@matbmoser matbmoser left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So I have added my comments, I believe if we specify more on "what should be there" and "what should be not there" it would be more precise.

Like a "Do’s and don’ts" section

FaGru3n
FaGru3n previously approved these changes Jul 24, 2024
Copy link
Contributor

@FaGru3n FaGru3n left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work and team effort, thanks for the work LGTM

@evegufy evegufy dismissed stale reviews from FaGru3n and tom-rm-meyer-ISST via 7f7de2f July 24, 2024 13:56
@evegufy
Copy link
Contributor

evegufy commented Jul 24, 2024

So I have added my comments, I believe if we specify more on "what should be there" and "what should be not there" it would be more precise.

Like a "Do’s and don’ts" section

Thanks for the good feedback, just the idea was to transfer the previous state of the styleguide without any new requirements, I suggest to open an update pull request to the TRG once this has been merged.

@evegufy evegufy requested a review from matbmoser July 24, 2024 14:00
Copy link
Contributor

@matbmoser matbmoser left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, wonderful job!

@evegufy evegufy merged commit 15665ff into eclipse-tractusx:main Jul 25, 2024
5 checks passed
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants