Skip to content

Add hook to check image names#464

Merged
fsimonis merged 1 commit intoprecice:developfrom
fsimonis:add-hook-to-check-image-names
Mar 8, 2024
Merged

Add hook to check image names#464
fsimonis merged 1 commit intoprecice:developfrom
fsimonis:add-hook-to-check-image-names

Conversation

@fsimonis
Copy link
Copy Markdown
Member

This PR adds a pre-commit hook that checks if the names of images in A/images/ are correctly prefixed.

The required prefix is: tutorial-<A>- or quickstart- if A is quickstart.

This is required to prevent conflicts in the website assets folder.

@MakisH
Copy link
Copy Markdown
Member

MakisH commented Mar 1, 2024

@fsimonis
Copy link
Copy Markdown
Member Author

fsimonis commented Mar 5, 2024

@MakisH should we make this optional or mandatory?

@fsimonis fsimonis force-pushed the add-hook-to-check-image-names branch from 59e4b8f to e3c0a6d Compare March 7, 2024 15:24
Copy link
Copy Markdown
Member

@MakisH MakisH left a comment

Choose a reason for hiding this comment

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

Feel free to merge once it is documented.
This is definitely a nice check!

@fsimonis
Copy link
Copy Markdown
Member Author

fsimonis commented Mar 8, 2024

I opened the RP for the documentation. Merging

@fsimonis fsimonis merged commit 5321b03 into precice:develop Mar 8, 2024
@fsimonis fsimonis deleted the add-hook-to-check-image-names branch March 8, 2024 17:25
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.

2 participants