Going through the README, I sometimes really wish there was a working example script for some explanation. For example "working with states" is mentioned briefly, but it's a rather big deal in any bigger project. The few examples available are great, but the number of example can be expanded to cover more cases.
The only downside is that we (as in myself and my cats - probably) need to maintain all the examples. Hence all the examples should become part of the build pipeline, and all of them should run gracefully for a successful build. At least then I can make sure that I never forget to update any of them. The CI pipeline will catch anything I don't.
A good idea is to go over all parts of the readme and make sure there's an example available and attached. Here's a list of some of my own wishes (in no particular order):
Going through the README, I sometimes really wish there was a working example script for some explanation. For example "working with states" is mentioned briefly, but it's a rather big deal in any bigger project. The few examples available are great, but the number of example can be expanded to cover more cases.
The only downside is that we (as in myself and my cats - probably) need to maintain all the examples. Hence all the examples should become part of the build pipeline, and all of them should run gracefully for a successful build. At least then I can make sure that I never forget to update any of them. The CI pipeline will catch anything I don't.
A good idea is to go over all parts of the readme and make sure there's an example available and attached. Here's a list of some of my own wishes (in no particular order):