symfony
[UX Reproducer] Could we introduce an UX context specific Reproducer Template?
Hey everyone, this a more general question, but I think it could be beneficial or everyone!
I had a problem with ux twig components and was asked to create a reproducer and I think this is helpful in many cases - I don't want to shift the work towards "others" per se, but even tho there is an article on how to create a bug reproducer for smyfony, I think especially in UX context this looks different from other symfony contexts - So I wondered, wouldn't it be awesome if symfony ux would provide a reproducer template? Like a repo on github we can clone? It could already set up the most basic stuff that makes sense for an ux related issue and we can throw in our example, push that to a new repo and provide it in a github issue?
For me personally I would love to help and provide you with a reproducer for my issue to iron out the amazing ux packages more and more, but it's hard to know what to setup, what is needed and what should be left out. I don't create new symfony projects so often, I don't even have composer, php or anything on my system, I usually work with docker containers to isolate all that stuff. So for me, creating a new symfony project means, I need to create a whole docker setup for it first and then I could create it, but without knowing what symfony packages make sense to keep it minimal - I'd guess a common symfony project create command would add doctrine and multiple other packages that might be unnecessary for ux, so having a ready to use template would save a huge amount of time and complexity to create a simple reproducer for ux related issues and I think everyone would benefit from such a thing, WDYT?
As already said on slack, i'm all in for this suggestion.
(and thank you very much for it)
I'm thinking to use ux.symfony.com code base as a place to build your reproducers. In this case, it would require some documentation and maybe some helpers within the ux.symfony.com code.
In a dream world there would be something like a code-pen for symfony ux, but that's a hell of a project 😂
I think using ux.symfony.com codebase might work, but we then also clone all the pages, styles, etc. of it, don't we? I mean that could work and it probably includes all the necessary ux packages, but will it lead to small reproducers?
Maybe this could work if we are using branches, like we fork the ux repo which includes a reproducer section and then we create a branch to adjust only in that section?
I am totally open to help, as far as I can and I also happily offer to beta test the template to use it to reproduce the issue I faced as soon as we have something available 😄
I think using ux.symfony.com codebase might work, but we then also clone all the pages, styles, etc. of it, don't we?
My thinking was we include a hidden "reproducer" route (only available in dev) that's just a blank slate (no styles).
Just updated the comment above, so basically a part in the project we fill out in a branch?
That sounds like a good idea to me 👍
My thinking was we include a hidden "reproducer" route (only available in dev) that's just a blank slate (no styles).
After short (but intense 😅 ) thinking .. i think we should create a dedicated repo and/or folder in the repo
The website will soon (already is) full of libs, scripts, assets, etc..
The website will soon (already is) full of libs, scripts, assets, etc..
Yep, very true
@CMH-Benny i'm wonderning what would be better:
- a github template repository (one click to start, and then it's up to you)
- a form on ux.symfony.com, (you select a couple of options and it generates an install script for you)
?
For me option one sounds good, my prime issue is, that I don't have local symfony cli, composer etc.
So for me cloning a repo that is preinitialized is easier, because I can then throw that folder into a docker container and do stuff, the container doesn't have smyfony-cli aswell, but composer
Can't speak for others, I'd guess having a install script generator could be nice for others, with different system setups :D
So for me it would be best to clone the Repo, mount it in a container, edit the code to add my reproducer and then push it to a new repo.
If there would be a repo with a ready to use docker image, that we could clone and then run the install script in that one, that contains everything that is needed, like composer, symfony-cli etc. would be fine as well :)
Just curious, was there some progress in the background regarding the reproducer template? I saw another issue suggesting a contributing readme, that probably would benefit from an aligned process on how a reproducer should be created? I think there also rings a bell that there is a tutorial on symfonycasts on how to create a reproducer, but probably not tailored to ux? @kbond @smnandre
Thank you for this suggestion. There has not been a lot of activity here for a while. Would you still like to see this feature? Every feature is developed by the community. Perhaps someone would like to try? You can read how to contribute to get started.
[!IMPORTANT] work in progress :)
I just created a repository template on Github: https://github.com/smnandre/ux-reproducer
This is just a newly created Symfony app, slimed down, with a basic layout and a clean minimal theme (thanks to Pico CSS).
Installed:
- Turbo
- Stimulus
- TwigComponent
- LiveComponent
- UX Icons
Next steps:
- configure Docker image
- configure welcome screen
- add examples
- add checklist
Thank you for this suggestion. There has not been a lot of activity here for a while. Would you still like to see this feature? Every feature is developed by the community. Perhaps someone would like to try? You can read how to contribute to get started.
Could I get an answer? If I do not hear anything I will assume this issue is resolved or abandoned. Please get back to me <3
Hard to tell, the template repository exists, so something was done - It's not clearly visible if this is still a work in progress or not, but as there was no activity for a while, I would assume it is still a work in progress?
Maybe @smnandre can shed some light on this?