Anyone know of good Gitlab CI or GitHub actions for auto generating GUI screenshots and links them in the README? I only barely know testing tool and frameworks like OpenQA and Robot for GUI. Even better if we can get AVIF/GIF linked in there to see an app in motion.

Honestly though, documenting is a pain enough, I really don't want to be doing screenshot walk throughs on anything I'm not paid to do.

I totally agree that screenshots and a proper description of the app in the README are a must-have for all foss apps, but as a developer I know that most of the times you prefer use your time to add new features to your app rather then documenting existing ones...

Personally I'll try to add them to all my future projects but what I would suggest to everyone who use and love a foss app is to check out its README and, if needed, submit a pull request with an updated version of it with screenshot etc (You don't need to be a developer to do that and it can be really appreciated)

No. ReadMe files should be concise, explicit, and text only. UI/UX screenshots can be part of the repo, wiki, or associated website but they shouldn't be in the ReadMe.

If you don't understand the software you're installing from some rando stranger's git repo then you shouldn't install it. Period. Take the opportunity to learn more or use another tool.

Git repos are not app stores. The devs don't owe you anything.

The vast majority of software in publicly accessible git repos are personal projects, hobbies, and one-off experiments.

Your relationship with the software and the devs that create and maintain it is your responsibility. Try talking to the devs, ask them questions, attempt to understand why they constructed their project in whatever specific way they have. You might make some new friends, or learn something really interesting. And if you encounter rudeness, hostility, or incompetence you're free to move on, such is the nature of our ever-evolving open-source community.

We bring a lot of preconceived notions into the open-source / foss / software development space as we embark on our own journey of personal development. I try to always remember it's the journey of discovery and the relationships we curate along the way that is the real prize.

Hey, all you folks ought to get together and publish a guide to writing good FOSS documentation,

Dear Open source devs: Do something I'm too lazy to contribute.