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

Contributing: add details for UI changes #14098

Merged
merged 1 commit into from
May 27, 2024
Merged

Conversation

maxwxyz
Copy link
Collaborator

@maxwxyz maxwxyz commented May 17, 2024

Adding a mandatory presentation for UI changing pull requests.

If a PR changes the user interface (UI), the body of the text MUST include a presentation of these UI changes, preferably with screenshots of the previous and revised state.

@FEA-eng
Copy link
Contributor

FEA-eng commented May 20, 2024

I guess that screenshots are needed only for bigger UI changes like toolbar modifications and task panel overhauls? If I only change some text in the task panel or update an icon then the screenshots aren't necessary as the commits themselves should be sufficient?

@maxwxyz
Copy link
Collaborator Author

maxwxyz commented May 20, 2024

I think also tooltips should be presented in the body, it must not be a screenshot but it can be text only. Otherwise you have to go through the files and compare.
For icon changes I'd still suggest screenshots as e.g. on the mobile GitHub app, .svg are not displayed as images but the code only. I'm not capable of drawing the icon in my head by looking at the .svg code 😉

@FEA-eng
Copy link
Contributor

FEA-eng commented May 20, 2024

Ok, makes sense and I’ll follow these rules.

I can see the icons on mobile but I’m using a browser, not GitHub app (I didn’t know there is one).
IMG_7592

@chennes chennes merged commit d9b9b58 into FreeCAD:main May 27, 2024
10 checks passed
@maxwxyz maxwxyz deleted the contributing-ui branch May 27, 2024 15:40
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 this pull request may close these issues.

None yet

3 participants